API Response Codes & Error Messages

Understanding the response codes for the Essentials API

  Date Updated: August 2014

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 to the API.

204

Updated OK

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

400

Bad Request

This is the standard success response code when the API hasn't recognised 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 Authentication Token is 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 uid that is carried in the api call you are making, to ensure it is valid.

500

Internal Server Error

This is the standard success response code when the server is miss-behaving.