Skip to main content
The API has been implemented using RESTful principles and uses HTTP request methods. All requests to the API receive an HTTP response code to confirm if the request was successful or not. Your API client should handle each response code as required:
  • 2XX codes - the call was successful.
  • 4XX codes - there was an error with the submitted request, such as a missing parameter or invalid value. You should modify requests before retrying.
  • 5XX codes - there was a server error.
HTTP response codeDefinitionWhen returned
200Standard response for successful HTTP requestsWhen the request has been successfully completed. 
This response is returned for a GET, POST and PUT.  Also returned even if an empty set is returned.
201CreatedNot returned
204No contentThe server successfully processed the request and has not returned any content.
400Bad RequestInvalid input parameters
401UnauthorisedCan be returned for two possible reasons: - Invalid user credentials have been included in the HTTP header. - Valid user credentials have been included in the HTTP Header but access has not been authorised to the endpoint.
403ForbiddenValid User credentials in the HTTP Header but the user does not have the required permissions to access the endpoint.
404Not foundThis is returned whenever the required item cannot be found.  This could be because of: - The specified item was not found when an item identifier has been included as part of the URI, e.g.  customer/123456/location/category/cat12.
406Not AcceptableThe output from the endpoint is not acceptable to the calling client (as defined by the Accept headers included in the request).
409ConflictThe request to the endpoint could not be completed as there is a conflict between the JSON data sent and the request to the endpoint.
429Too many requestsThe request to the endpoint could not be completed because the rate restriction limit has been exceeded.
500Internal server errorThere has been an internal error within the API.
If there has been an error, the following JSON object is returned: 
{
	 "errorCode": "",
	 "errorMsg":	"error	message and corrective actions to take"
}
errorMsg - includes details of the error and what corrective action to take; for example, if an incorrect icon name has been specified, then the errorMsg includes a list of all the valid icon names. The API has an 8K limit on the length of the request line and header fields sent to an endpoint. If the 8K limit is exceeded, then the request will be rejected and no error code will be returned. You can read more about status codes at HTTP status codes.