API Response Codes & Error Messages

Understanding the error codes for the EXO API

Date Updated: April 1st 2015

EXO API uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter missing), and the codes in the range 5xx indicate an error with the EXO API servers. Our API bindings can raise exceptions for many reasons like invalid parameters, authentication errors etc. We recommend always trying to gracefully handle exceptions from our API.

200

Success

This is the standard success response code when you request something from the API.

201

Created OK

This is the standard success response code when you POST or PUT to the API.

202

Accepted

This response indicates that the request has been accepted for processing, but the processing has not been completed.

400

Bad Request

This is the standard success response code when the API hasn't recongised your request.

When seeing this error, check you are setting all the required headers correctly.

401

Unauthorised

This is the standard 'blocked' response code from the API service.

To resolve this we recommend you check your EXO Token and permissions are correct.

403

Forbidden

This is the standard success response code when an item you have attempted a request that is not allowed.

404

Resource Not Found

This is the standard success response code when an item you have requested can't be found.

When seeing this error, check any ID that is carried in the API call you are making, to ensure it is valid.

If this error is returned when requesting a report via the EXO API, check that the report is available and that the correct report name was passed to the API.

408

Timeout

This response can be returned when requesting a report via the EXO API. It indicates that the report was too large and failed to complete within the timeout period of 90 seconds.

410

Resource Removed

This is the standard success response code when a resource you requested has been removed.

500

Internal Server Error

This is the standard success response code when the server (or desktop API service) is misbehaving.

If it is returned when requesting a report via the EXO API, check the report's design to ensure that it is valid.