HTTP status codes used by the API

The following HTTP status codes should be implemented and covered in request-response protocol on your side while we make heavy use of them.

200 OK

Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action.

204 No Content

The server successfully processed the request and is not returning any content.

404 Not Found

The requested resource could not be found, but may be available again in the future. Subsequent requests by the client are permissible.

400 Bad Request

The server cannot or will not process the request due to an apparent client error.

401 Unauthorized

Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided. The response must include a WWW-Authenticate header field containing a challenge applicable to the requested resource. 401 semantically means “unauthenticated”, meaning “you don’t have necessary credentials”.

422 Unprocessable Entity

The request was well-formed, but was unable to be followed due to semantic errors.

500 Internal Server Error

A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.