Conheça os status codes para cada endpoint e os possíveis erros que podem ser retornados pela Planning API.
Abaixo a tabela com os status codes para cada endpoint disponível na Planning API:
|
Código |
Método |
Endpoint |
Descrição |
|---|---|---|---|
|
201 |
POST |
Requisição Criada |
|
|
400 |
POST |
Error: Bad Request (falta de parâmetros, envio incompleto ou requisição com erros) |
|
|
500 |
POST |
An Internal Server Error occurred (erro interno no processamento da requisição) |
|
|
200 |
GET |
OK (solução encontrada através do ID) |
|
|
404 |
GET |
NOT FOUND (não encontrado por ID incorreto ou processamento não finalizado) |
|
|
500 |
GET |
An Internal Server Error occurred (erro interno no processamento da requisição) |
A tabela a seguir mostra todas as mensagens de erro que podem ser retornadas pela Planning API no body da resposta:
|
Código de erro |
Mensagem |
Descrição |
|
VALIDATION_FAILED ou VALIDATION_ERROR |
{ message: "", errors: [ ] } |
Erros de validação simples, o array errors contém a mensagem detalhada para cada campo contendo valor inválido (exemplo: "tripProfile is mandatory" indica que este campo é obrigatório mas não foi informado) |
|
MESSAGE_FORMAT_ERROR |
- |
O json da request possui erros e não pôde ser processado |
|
PROFILE_NOT_FOUND |
Error checking trip profile with name {tripProfileName} |
O tripProfile com o nome especificado não existe ou não é acessível para o clientId passado no header |
|
PROBLEM_NOT_FOUND |
- |
O problema com o id especificado não foi encontrado (não existe ou o clientId passado no header não é o do cliente que o criou) |
|
SOLUTION_NOT_FOUND |
- |
A solução com o id especificado não foi encontrada (não existe ou o clientId passado no header não é o do cliente que criou o problema) |
|
INVALID_SITE_POSITION |
Some sites have not been positionned |
Algum(s) dos sites possui coordenadas que não puderam ser conectadas a uma via próxima (pode variar de acordo com o mapa usado) |
|
NO_PROJECTION |
No projection retrieved to send to route planner |
Similar ao erro INVALID_SITE_POSITION, possui a mesma causa raiz, mas também pode ocorrer ocasionalmente quando um dos serviços internos está indisponível |
|
EMPTY_RESTRICTION_ZONE |
The name of restriction zones are invalid or the calculation of blocked arcs was not completed yet. |
Uma ou mais zonas de restrição informadas não existem (ou acabaram de ser cadastradas e ainda não foram processadas) |
|
NO_COORDINATES |
No coordinates found for arcs in map |
Algum dos sites foi passado sem coordenadas, ou com coordenadas incompletas |
|
INVALID_CALLBACK_URL_FORMAT |
URL do callback informada não possui formato válido |
|
|
INVALID_TIME_WINDOW |
must have the start less than or equal to the end |
Uma janela de tempo especificada onde o horário de término é anterior ao valor de início |
|
Não possui |
Impossible to get optimization profile |
O optimizationProfile com o nome especificado não existe |
|
ax.rp.errXXX |
- |
Problemas ocorridos no roteirizador, geralmente ligados a inconsistências no mapa usado, ocasionalmente por instabilidades. XXX é o código numérico do erro. |
|
ax.rp.err113 |
Not possible to create route between site A and B |
O roteirizador não encontrou um caminho do site A para o site B (pode variar de acordo com o mapa usado). Exemplo de um caso: A é uma via sem saída com sentido único |