Error messages
La siguiente tabla muestra todos los mensajes de error que la API puede devolver en el campo message:
| Parámetro | Mensaje | Descripción |
|---|---|---|
zipcode / label | The zipcode field must contain exactly 8 digits | El CEP no se informó, ni en el parámetro zipcode ni en el label, o no tiene exactamente 8 dígitos después de quitar el guión. |
road | size must be between 0 and 150 | El road tiene más de 150 caracteres. |
label | Structure error on label field | Falta al menos una de las cinco comas de separación en el label. Este error tiene prioridad sobre los errores de formato del CEP. |
| Todos | Request body cannot be empty | Ninguno de los parámetros road, number, zipcode, district, city o label fue completado. |
Ejemplo con el formato label
En el ejemplo siguiente, el label tiene solo cuatro comas, porque falta la separación entre la calle y el número:
{
"label": "av paulista 1578,bela vista,01310200,sao paulo,SP"
}
La solicitud será rechazada con la respuesta siguiente:
{
"title": "Constraint Violation",
"status": 400,
"violations": [
{
"field": "analyze.request.label",
"message": "Structure error on label field"
}
]
}
Ejemplos con el formato estructurado
CEP con menos de 8 dígitos
En el ejemplo siguiente, el zipcode tiene solo 7 dígitos después de quitar el guión:
{
"road": "r da cantarera 306 box 12",
"number": "",
"zipcode": "01024-00",
"district": "centro",
"city": "sao paulo",
"state": "SP"
}
La solicitud será rechazada con la respuesta siguiente:
{
"title": "Constraint Violation",
"status": 400,
"violations": [
{
"field": "analyze.request.zipcode",
"message": "The zipcode field must contain exactly 8 digits"
}
]
}
Calle por encima del límite de caracteres
En el ejemplo siguiente, el road tiene más 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"
}
La solicitud será rechazada con la respuesta siguiente:
{
"title": "Constraint Violation",
"status": 400,
"violations": [
{
"field": "analyze.request.road",
"message": "size must be between 0 and 150"
}
]
}
