Documentation

In error handling, frequently-used response codes are generally utilised. This paragraph highlights a few generic examples. Specific response codes are mentioned in the detailed documentation.

A response code can be both positive and negative; technically, there is no difference.

Response code Response text Explanation
200 OK OK
401 Unauthorized Unauthorized: You need to be logged in to use this method.
Unauthorized: Expired token
Authentication failed for whatever reason.
Specific: JWT expired
403 Forbidden Forbidden: User does not have rights to perform action.
Forbidden: Insufficient rights [<<RIGHT>>].

Forbidden: You are not allowed to use this method from your address

Authorisation failed.
In most cases this means one or more rights are missing.
The first missing right is supplied in the error message.
"Address" message is indicating a firewall is in place.

404 Not found Not Found: The requested resource cannot be found.
412 Precondition failed Precondition Failed: One of the required input parameters is missing.
500 Internal server error Internal Server Error: Something really went bad.

In the case of an error code: a more detailed description will usually be added. When an input parameter is missing, for example, the system will respond with the name of the parameter. Be aware that only the first missing parameter will trigger the error code, and there may be more required parameters missing. However, only the first one will be shown.

Functional information: