Skip to main content
Version: 2.82.x.x LTS

Query REST Service error response

When an error occurs, the service returns an error response containing the relevant HTTP status code. The table [below] lists the possible HTTP status codes. Each status code relates to a certain error type:

Status codeDescription
400 Bad RequestCould not parse request.
401 UnauthorizedNo authentication credentials provided or authentication failed.
403 ForbiddenAuthenticated user does not have access.
404 Not FoundResource not found.
500, 501, 502, 503, etcAn internal server error occurred.

If available, the response body also contains an error message.

E.g., the system returns the following response if the mandatory q URL parameter is empty:

HTTP/1.1 400 Bad Request
{
"messages": {
"errors": [
"Parameter 'q' is mandatory."
]
},
"response": null
}