Status Codes

API Responses

A status code is contained in every API response and indicates success or failure. Checking for success is as easy as to check whether the StatusCode in the response is 0, otherwise an error occurred.

In case of an error situation the response contains also a message which (hopefully) describes the cause of the problem.

{
  "StatusCode": <INTEGER>,
  "Message": <STRING>
}

List of Status Codes

Code Name
0 SUCCESS
1 UNKOWN_API_EXCEPTION
2 ROUTING_EXCEPTION
3 MISSING_PARAMETER_EXCEPTION
4 RECORD_NOT_FOUND_EXCEPTION
5 PARAMETER_PARSE_EXCEPTION
6 INVALID_PARAMETER_VALUE_EXCEPTION
7 INVALID_NETWORK_EXCEPTION