Error Handling

Error Logging

When logging an error, please preserve the following pieces of information:

• The Request ID
• The error code & message
• The request parameters (query parameters and/or request body, depending on size)
• Any supplier / product / rate / booking / hold IDs associated with the request
• The time of the request.

This information is vital when troubleshooting an issue with the Reseller API.

Error Object

xxxxxxxxxx

{

    "error": {

        "code": "UNAUTHORIZED",

        "message": "cannot locate Booking API user with API key "

    },

    "meta": {

        "reqId": "544ce05d03b43cb22d8cffef05dead0c"

    }

}

The error object contains three fields: code and message , which should appear on every error, and data which may contain additional context about the returned failure.

The code field should contain the HTTP status response code as a human-readable string, e.g. BAD_REQUEST,CONFLICT,ENTITY_TOO_LARGE,FAILED_DEPENDENCY,FORBIDDEN,GONE,INTERNAL_SERVER,NOT_FOUND,UNAUTHORIZED,UNAVAILABLE.

The message field contains a brief description of the error returned by the system.

The data field contains additional structured elements that may reveal additional context around the returned error.

Lastly, the meta field will always contain an object with a reqId ("Request ID") field. This should either be the request ID sent by the client or, if none was sent, a unique request ID issued by the API.