Error responses¶
Protocol description¶
Every response is JSON.
If the HTTP status is not OK (<200 or >=400), the response contains a JSON mapping, with the following attributes:
code
: matches the HTTP status code (e.g400
)errno
: stable application-level error number (e.g.109
)error
: string description of error type (e.g."Bad request"
)message
: context information (e.g."Invalid request parameters"
)info
: additional details (e.g. URL to error details)
Example response
{
"code": 400,
"errno": 109,
"error": "Bad Request",
"message": "Invalid posted data",
"info": "https://server/docs/api.html#errors"
}
Error codes¶
status code | errno | description |
401 | 104 | Missing Authorization Token |
401 | 105 | Invalid Authorization Token |
400 | 106 | request body was not valid JSON |
400 | 107 | invalid request parameter |
400 | 108 | missing request parameter |
400 | 109 | invalid posted data |
404 | 110 | Invalid Token / id |
404 | 111 | Missing Token / id |
411 | 112 | Content-Length header was not provided |
413 | 113 | Request body too large |
412 | 114 | Resource was modified meanwhile |
405 | 115 | Method not allowed on this end point |
429 | 117 | Client has sent too many requests |
403 | 121 | Resource’s access forbidden for this user |
409 | 122 | Another resource violates constraint |
500 | 999 | Internal Server Error |
503 | 201 | Service Temporary unavailable due to high load |
410 | 202 | Service deprecated |
Validation errors¶
In case multiple validation errors occur on a request, they will be returned one at a time.