Http Status Codes

The API will return a small subset of the available http status codes for indicating the result of a request. The possible status codes that can be returned are detailed below.

2xx Codes

Status codes in this range indicate a successful request.

200 - OK
Standard response for successful HTTP requests. The actual response will depend on the request method used. In a POST request, the response will contain an entity describing or containing the result of the action.

4xx Codes

Status codes in this range indicate an error on the client side.

400 - Bad Request
The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, too large size, invalid request message framing, or deceptive request routing).

403 - Forbidden
The request was valid, but the server is refusing to respond to it. The user might be logged in but does not have the necessary permissions for the resource. A possible cause is that a valid service authentication certificate was not supplied with the request.

404 - Not Found
The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible.

405 - Method Not Allowed
A request method is not supported for the requested resource; for example, a PUT request on a read-only resource.

5xx Codes

Status codes in this range indicate an error on the server side.

500 - Internal Server Error
A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.

503 - Service Unavailable
The server is currently unavailable (because it is overloaded or down for maintenance). Usually this state is only temporary.