Área / Area

Cadastro / Add

[PT] Este serviço permite o cadastro de uma área. Um JSON no formato abaixo relacionado deve ser enviado como payload. Os campos obrigatórios estão marcados com um "*" na aba "Model".

[EN] Creates a new area. The payload to be sent is the bellow JSON. Required fields have a asterisk mark "*" in "Model" tab.

post/areas

Request

  • Base URL: https://api.nexti.com
  • URL: https://api.nexti.com/areas
  • Auth: OAuth 2 (client credentials, token URL https://api.nexti.com/security/oauth/token)

Request body

idinteger

[PT]ID da área [EN]Area ID

namestring required

[PT]Nome da área [EN]Area name

codestring

[PT]Código da área [EN]Area code

externalIdstring

[PT]ID externo da área [EN]Area External ID

personResponsibleIdinteger required

[PT]ID do responsável pela área [EN]Responsible for the area ID

personResponsibleExternalIdstring required

[PT]ID Externo do responsável pela área [EN]Responsible for the area External ID

sendEmailSupboolean required

[PT]Enviar email para supervisor [EN]Send email to supervisor

sendEmailRespboolean required

[PT]Enviar email para responsável [EN]Send email to Responsible

personSupervisorIdsinteger[]

[PT]ID dos Supervisores da área [EN]Area supervisor IDs

personSupervisorExternalIdsstring[]

[PT]ID externo dos Supervisores da área [EN]Area supervisor External IDs

workplaceIdsinteger[]

[PT]ID dos Postos da área [EN]Area workplace IDs

workplaceExternalIdsstring[]

[PT]ID externo dos Postos da área [EN]Area workplace External IDs

activeboolean

[PT]Ativo [EN]Active

clientIdsinteger[]

[PT]ID dos Clientes da área [EN]Area client IDs

clientExternalIdsstring[]

[PT]ID externo dos Clientes da área [EN]Area client External IDs

scheduleTurnIdsinteger[]

[PT]ID dos Turnos da área [EN]Area schedule turn IDs

scheduleTurnExternalIdsstring[]

[PT]ID externo dos Turnos da área [EN]Area schedule turn External IDs

Example request

{
  "name": "Zona leste",
  "code": "Z-09",
  "personSupervisors": [
    {
      "gender": "'M', 'F'",
      "birthDate": "ddMMyyyyHHmmss",
      "admissionDate": "ddMMyyyyHHmmss",
      "demissionDate": "ddMMyyyyHHmmss",
      "issueDateRegisterNumber": "ddMMyyyyHHmmss",
      "initialsRegisterNumber": "RJ",
      "maritalStatusExternalId": "002",
      "maritalStatusName": "Solteiro",
      "publicArea": "Rua, avenida, Travessa",
      "federatedUnitInitials": "SC, SP",
      "markings": [
        480,
        720,
        760,
        880
      ],
      "referenceDate": "YYYY-MM-DD",
      "ignoreTimeTrackingDate": "ddMMyyyyHHmmss"
    }
  ]
}

Response

OK

idinteger

ID do response

messagestring

Mensagem do response

commentsstring[]

Comentários do response

Example response

{
  "value": {
    "name": "Zona leste",
    "code": "Z-09",
    "personSupervisors": [
      {
        "gender": "'M', 'F'",
        "birthDate": "ddMMyyyyHHmmss",
        "admissionDate": "ddMMyyyyHHmmss",
        "demissionDate": "ddMMyyyyHHmmss",
        "issueDateRegisterNumber": "ddMMyyyyHHmmss",
        "initialsRegisterNumber": "RJ",
        "maritalStatusExternalId": "002",
        "maritalStatusName": "Solteiro",
        "publicArea": "Rua, avenida, Travessa",
        "federatedUnitInitials": "SC, SP",
        "markings": [
          480,
          720,
          760,
          880
        ],
        "referenceDate": "YYYY-MM-DD",
        "ignoreTimeTrackingDate": "ddMMyyyyHHmmss"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.