Error Codes API Documentation
v1
The elements that make up the error messages are detailed in the following table:
| Http Status Code | Description |
|---|---|
400REQUEST_INVALID | Request element does not follow the request contract. |
400INVALID_MEMBER | If an invalid membership number is supplied from Offline channels. |
401REQUEST_UNAUTHORIZED | Token in authorisation header is invalid for the Programme identifier is invalid. |
403DEVELOPER_NOT_AUTHORIZED | The provided API key does not provide access to this endpoint. |
403DEVELOPER_INACTIVE | The provided API key is no longer active and access to this endpoint is forbidden. |
403USAGE_RATE_EXCEEDED | The usage rate (calls per second) has been exceeded for the API Key. |
403USAGE_RATE_LIMIT_EXCEEDED | The usage rate limit (calls per day) has been exceeded for the API Key. |
403SSL_REQUIRED | This endpoint is required to be accessed using SSL. |
406 | The provided Accept header is invalid. |
415 | The provided content-type value is invalid. |
503SCHEDULED_MAINTENANCE | This endpoint is not available due to scheduled maintenance. |
503SYSTEM_UNAVAILABLE | When a system is not available. |
504GATEWAY_TIMEOUT | This endpoint has failed to respond within the expected time. |
596 | The provided HTTP method is other than ‘POST‘, 'PATCH', 'GET' or 'DELETE'. |