Error Handling
Common Error Codes
| Status Code |
Type |
Description |
| 200 |
OK |
The request has succeeded. |
| 400 |
INVALID_REQUEST |
One or more inputs are invalid because they contain errors. See details for guidance. |
| 401 |
NO_AUTH_KEY |
An authorization token is required to access this resource. |
| 403 |
INVALID_AUTH_KEY |
The authorization token is either corrupted, revoked, or has an invalid signature. |
| 403 |
ACCOUNT_EXPIRED |
The authorization token was revoked. |
| 403 |
OUT_OF_BOUND_LOCATION |
Location (lon: {}°, lat: {}°) is not within the territory covered by the current service offer. |
| 404 |
NO_SPATIAL_COORDINATES |
No coordinates are available for the provided location's description. |
| 429 |
TOO_MANY_REQUESTS |
Excessive number of requests submitted to the server. Please insert a delay of approximately 50 to 100 milliseconds between requests. |
| 429 |
QUOTA_REACHED |
Maximum number of requests reached for the underlying authorization key. Please get in touch with support (support@geosapiens.ca) for more information. |
| 500 |
INTERNAL_SERVER_ERROR |
This is an exceptional server-side error. Please get in touch with support (support@geosapiens.ca) to report it. |
| 500 |
NO_DATA |
No data available for the provided location. This is an exceptional server-side error. Please get in touch with support (support@geosapiens.ca) to report it. |
Example Error Response
{
"uuid": "739cf562-1016-4275-aafd-42f9e5102fa3",
"timeStamp": "2023-8-11 14:51:55 UTC",
"statusCode": 401,
"status": "Unauthorized",
"type": "NO_AUTH_KEY",
"description": "An authorization token is required to access this resource."
}