Logical Errors

On the right you find a response sample of a handled exception. The Response Code 0001 indicates that mandatory fields are missing or syntax errors (e.g., wrong datatype, spelling) exist in the API request.

Another important exception has the response code 0096 and occurs when the user tries to perform an unauthorized API call. This means that the provided X-Auth-Token in the HTTP-Header is either missing or invalid (see section API Authentication).

Please note, that the response codes 0058 and 0098 allow a retry of the API call up to 3 times.

In most cases, the response code provides enough information, which allow you to further investigate the source of the error. Otherwise you can contact our Customer Support.

Response sample

Status Code:

400 (Bad Request)

Header:

Content-Type: application/json
Accept-Language: en-US

{
"partnerReference": "78838436FDD0445081099C7D931F7041",
"responseCode": "0001",
"responseDescription": "One or more of the required fields has not been sent or was not properly received by the API: 'programCode'.",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}