Error Handling

API Documentation / Error Handling

HTTP Error Status Codes

If we cannot process your request, we use the following HTTP Status Codes for indicating the type of error:

Error responses without messages

For the HTTP status codes 400, 401 and 500 we do not return more detailed messages. An example for a bad request could look like the following:

> HTTP/1.1 400 Bad Request
> Cache-Control: no-cache
> Pragma: no-cache
> Content-Type: application/json; charset=utf-8
> Expires: -1
> Server: Microsoft-IIS/7.5
> X-AspNet-Version: 4.0.30319
> X-Powered-By: ASP.NET
> Date: Fri, 06 Mar 2015 13:08:28 GMT
> Content-Length: 0
          

Error responses with messages

For the HTTP status codes 404, 422 and 503 we return a error messages that are supposed to help the client application to distinguish between different error scenarios. The format of the payload is defined by the Content-Type header sent with your request. You will get back an array of error messages that by themself consist of 3 fields:

• code — Predefined numeric error code
• text — Predefined error message
• extra_info — Optional field that contains additional information about the error.

Here is an example of an error response for a request with an invalid payload:

> HTTP/1.1 422 Unprocessable Entity
> Cache-Control: no-cache
> Pragma: no-cache
> Content-Type: application/json; charset=utf-8
> Expires: -1
> Server: Microsoft-IIS/7.5
> X-AspNet-Version: 4.0.30319
> X-Powered-By: ASP.NET
> Date: Fri, 06 Mar 2015 13:11:51 GMT
> Content-Length: 88
> 
> {
>     "messages" : [{
>         "code" : 320,
>         "text" : "Invalid value",
>         "extra_info" : "arrivalDate is invalid"
>     }]
> }
          

The list of currently returned error codes and messages is aligned with the OpenTravel 2012A Publication.