To ensure a client system knows whats going on, the APIs make use of a number of status codes
| Code | Description |
|---|---|
| 200 | Successful request |
| 201 | Created |
| 400 | Validation error |
| 401 | Unauthorised |
| 403 | Insufficient permissions |
Across each API, if an error occurs, whether it be an server error or just a validation error, it will be returned in a standardised JSON format (as below).
{
"error": "error message"
}However, if the environment variable HTTP_ERROR is set to DEBUG, a detailed stack trace will be returned as well - which looks like this:
{
"error": "error message",
"stackTrace": "probably quite a long trace"
}This is ideal for debugging and development but probably not for production. When in production mode either don't set the HTTP_ERROR variable or set it to something other than DEBUG.