Área / Area

Atualizar / Update

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

[EN] Updates the specified Area by external id. The payload to be sent is the bellow JSON. Required fields have a asterisk mark "*" in "Model" tab.

put/areas/externalId/{externalId}

Request

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

Path parameters

externalIdstring required

Request body

object required

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.