Responses

HTTP status codes

There are multiple type of HTTP status codes for different types of states.

Below you will find a list of code ranges.

HTTP status code	Description
2xx - success	Request was successful.
4xx - client errors	The request failed, caused by the client.
5xx - server errors	The request failed, caused by the server.

Response errors

In case of errors, there are multiple HTTP status codes for different types of errors.

HTTP status code	Description
400 Bad Request	Error caused by the client app, e.g. a malformed request. In most cases, such an error signifies a bug in the client app.
401 Unauthorized	Error caused by using an invalid token, or because the token doesn't have the right scope and/or permission to use this endpoint.
403 Forbidden	Error caused by missing required permissions, and should be reported to the end user of the client app.
404 Not Found	Error caused by not being able to find or identify the requested document or endpoint.
500 Internal Server Error	Unexpected error of the server. In most cases, this error signifies a bug on our side. We are logging these bugs and are notified when such an error happens.

When an error occurs, the following JSON object will be responded.

Property	Type	Contract	Description
code	integer	required	HTTP status code.
error	string	required	Brief identifier of the error type.
message	string	optional	Description of the error.
details	object	optional	Additional details which might provide more information regarding the cause of this error.

Example in JSON format:

{
  "code": 401,
  "error": "NotFoundError",
  "message": "The resource could not be found",
  "details": {
    "index": "equipment"
  }
}