Error Codes
Below is the list of error codes and descriptions for this API.
NOTE: This list will be finalized when implementation finishes.
| Code | Error | Description |
|---|---|---|
| 400 | Bad Request | For example, when JWT token is not included in HTTP request header. |
| 401 | Unauthorized | When the client application doesn't have access permission of the API or token expired. |
| 403 | Forbidden | Client is not allowed to access requested resource. |
| 404 | Resource Not Found | When requested URI doesn't exist for the API. |
| 405 | Method Not Allowed | For example, perform POST method on API where it only supports GET. |
| 408 | Request Timeout | For example, a client request that exceeds a specific time limit, or closing an unused connection. |
| 415 | Unsupported Media Type | For example, client sent data in plain text when API expects JSON format. |
| 422 | Input Parameter Validation Failed | For example, required IMSI not present or timestamp in incorrect format. |
| 429 | Too Many Requests | Indicates the client has sent too many requests in a given amount of time ("rate limiting"). |
| 453 | Entitlement Check Failed | When the client application is not entitled to access the data for a requested device. |
| 500 | Internal Server Error | When other uncaught incidents (errors) occur. |
| 502 | Bad Gateway | For example, when accessing the API external URL via HTTP rather than HTTPS. |