Error Codes API Documentation

v1

The elements that make up the error messages are detailed in the following table:

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