Error messages – Planning
The following table shows all the error messages that can be returned by the API in the response body:
| Error code | Message | Description |
VALIDATION_FAILED or VALIDATION_ERROR | { message: "", errors: [ ] } | Simple validation errors. The errors array contains the detailed message for each field containing an invalid value (example: "startDate is mandatory" indicates that this field is mandatory but has not been entered). |
MESSAGE_FORMAT_ERROR | – | The request json has errors and could not be processed. |
PROFILE_NOT_FOUND | Error checking trip profile with name {tripProfileName} | The tripProfile with the specified name does not exist. |
PROBLEM_NOT_FOUND | – | The problem with the specified id was not found. |
SOLUTION_NOT_FOUND | – | The solution with the specified id was not found. |
INVALID_SITE_POSITION | Some sites have not been positionned | Some of the sites have coordinates that could not be connected to a nearby road. |
NO_PROJECTION | No projection retrieved to send to route planner | Similar to the error INVALID_SITE_POSITION, it has the same root cause, but can also occur occasionally when one of the internal services is unavailable. |
EMPTY_RESTRICTION_ZONE | The name of restriction zones are invalid or the calculation of blocked arcs was not completed yet. | One or more of the restriction zones reported do not exist (or have just been registered and have not yet been processed). |
NO_COORDINATES | No coordinates found for arcs in map | Some of the sites were passed on without coordinates, or with incomplete coordinates. |
INVALID_CALLBACK_URL_FORMAT | {callbackValue} does not have a valid value. Example of allowed values: http://www.foo.br, https://www.foo.br… | URL of callback entered does not have a valid format. |
INVALID_TIME_WINDOW | must have the start less than or equal to the end | A specified time window where the end time is earlier than the start time. |
| – | Impossible to get optimization profile | The optimizationProfile with the specified name does not exist. |
ax.rp.errXXX | – | Problems occurring in the route planner, usually linked to inconsistencies in the map used, occasionally due to instabilities. XXX is the numerical error code. |
ax.rp.err113 | Not possible to create route between site A and B | The route planner has not found a path from point A to point B. Example of a case: Point A is a one-way dead-end road. |
