Handling Errors

This page contains some general information about handling errors in the Extra Horizon (ExH) platform.

All errors reported by the API have a HTTP status code and follow the standard.

When an error happens, the error response body is always a JSON object with the following fields:

{
  "code": 13,
  "name": "EMPTY_BODY_EXCEPTION",
  "message": "The request body is empty"
}

Common Errors

Error code	HTTP status	Name	Description
12	400	ID_FORMAT_EXCEPTION	The provided unique identifier is of an invalid format.
16	404	RESOURCE_UNKNOWN_EXCEPTION	A resource linked to a unique identifier can not be found.
21	401	LONG_QUERY_EXCEPTION	The query exceeds the maximum execution time.

Authentication Errors

Possible errors that are thrown by endpoints requiring authentication:

Error code	HTTP status	Name	Description
10	401	NO_PERMISSION_EXCEPTION	The endpoint expected the user to have a specific permission, but the authenticated user did not.
104	401	USER_NOT_AUTHENTICATED_EXCEPTION	The endpoint expected that user authentication was present, but it was missing.
107	401	OAUTH_KEY_EXCEPTION	The supplied OAuth 1 consumer key is unknown.
108	401	OAUTH_TOKEN_EXCEPTION	The supplied OAuth 1 token is unknown (in combination with the consumer_key).
109	401	OAUTH_SIGNATURE_EXCEPTION	The supplied OAuth 1 signature did not match the signature calculated by the API. Possibly the token secret or consumer secret was wrong. Or the signature generation it self is not setup correctly.
110	401	DUPLICATE_REQUEST_EXCEPTION	The supplied OAuth 1 parameters where already send once before. Make sure the time and nonce parameters are updated for each request authenticated with OAuth1.
117	401	ACCESS_TOKEN_UNKNOWN_EXCEPTION	The supplied OAuth 2 access token is unknown.
118	401	ACCESS_TOKEN_EXPIRED_EXCEPTION	The supplied OAuth 2 access token is expired.

Request Body Errors

Possible errors that are thrown by all endpoints accepting a request body:

Error code	HTTP status	Name	Description
13	400	EMPTY_BODY_EXCEPTION	The endpoint expected a request body, but it was missing.
14	400	MISSING_REQUIRED_FIELDS_EXCEPTION	The endpoint expected a field to be specified, but it was missing.
15	400	FIELD_FORMAT_EXCEPTION	The provided body contained a field with a value that did past the validation.
22	400	BODY_FORMAT_EXCEPTION	The provided body could not be interpreted correctly.

RQL Errors

Possible errors for endpoints that accept RQL:

Error code	HTTP status	Name	Description
19	400	INVALID_RQL_EXCEPTION	Possibly an error in the syntax of the supplied RQL. Look out for spaces, comma's and other special characters.
20	400	EMPTY_RQL_EXCEPTION	The endpoint expected RQL to be supplied, but was missing.