Address Analyzer

Error messages

A tabela a seguir mostra todas as mensagens de erro que podem ser retornadas pela API no campo message:

ParâmetroMensagemDescrição
zipcode / labelThe zipcode field must contain exactly 8 digitsO CEP não foi informado, nem no parâmetro zipcode, nem no label, ou não possui exatamente 8 dígitos após a remoção do hífen.
roadsize must be between 0 and 150O road possui mais de 150 caracteres.
labelStructure error on label fieldFalta pelo menos uma das cinco vírgulas de separação no label. Esse erro tem precedência sobre os erros de formato do CEP.
TodosRequest body cannot be emptyNenhum dos parâmetros road, number, zipcode, district, city ou label foi preenchido.

Exemplo com o formato label

No exemplo abaixo, o label possui apenas quatro vírgulas, pois falta a separação entre o logradouro e o número:

{
  "label": "av paulista 1578,bela vista,01310200,sao paulo,SP"
}

A requisição será rejeitada com a resposta abaixo:

{
  "title": "Constraint Violation",
  "status": 400,
  "violations": [
    {
      "field": "analyze.request.label",
      "message": "Structure error on label field"
    }
  ]
}

Exemplos com o formato estruturado

CEP com menos de 8 dígitos

No exemplo abaixo, o zipcode possui apenas 7 dígitos após a remoção do hífen:

{
  "road": "r da cantarera 306 box 12",
  "number": "",
  "zipcode": "01024-00",
  "district": "centro",
  "city": "sao paulo",
  "state": "SP"
}

A requisição será rejeitada com a resposta abaixo:

{
  "title": "Constraint Violation",
  "status": 400,
  "violations": [
    {
      "field": "analyze.request.zipcode",
      "message": "The zipcode field must contain exactly 8 digits"
    }
  ]
}

Logradouro acima do limite de caracteres

No exemplo abaixo, o road possui mais de 150 caracteres:

{
  "road": "rua da cantareira 306 box 12 mercado municipal de sao paulo entrada pela porta lateral proximo ao estacionamento falar com o responsavel pelo recebimento no horario comercial",
  "number": "",
  "zipcode": "01024-000",
  "district": "centro",
  "city": "sao paulo",
  "state": "SP"
}

A requisição será rejeitada com a resposta abaixo:

{
  "title": "Constraint Violation",
  "status": 400,
  "violations": [
    {
      "field": "analyze.request.road",
      "message": "size must be between 0 and 150"
    }
  ]
}