Stays API Error Messaging

The TripServices Stays APIs use the error handling detailed next and return the standard error messages listed in this topic.

The TripServices Stays APIs can return either errors or warnings:

• Errors: Returned in Result/Error when request processing is unsuccessful.
• Warnings: Returned in Result/Warnings when the request was successful but certain conditions were noted, such as if a search was unable to return rates for one or more properties.

The Stays APIs currently use two versions of errors, depending on your customer provisioning setup. The older version returns the following objects:

• StatusCode
• Message

The newer error version returns all of the following objects:

• StatusCode
• Message
• SourceID
• SourceCode
• Category

The error messages differ by whether you are on the older or newer error versioning. Specific error messages are listed below in Error Message List.

For SourceCode, the values returned are grouped into the following ranges:

• 1: Impairment errors
• 1000: Common object validation errors: Errors related to object and property validation issues
• 2000: System-wide errors: Can occur for any content and in any workflow. Include communication, authorization, header, or query parameter errors.
• 13000: Hotel-specific errors

SourceID may return the value API or a supplier code.

• API: Returned for any business or impairment error in which the source was the API.
• Hotel chain code: Returned for supplier or other errors where the error source was not the API.

The following example shows the error message format of the older error versioning.

{
    "ErrorResponse": {
        "traceId": "hotel-ts-v11",
        "Result": {
            "@type": "Result",
            "Error": [
                {
                    "@type": "Error",
                    "StatusCode": 400,
                    "Message": " Property Code is a required field"
                }
            ]
        }
    }
}

The following example shows the error message format of the older error versioning.

"ErrorResponse": {
    "traceId": "a01432e6-5413-43ba-ba54-eb284273b3ac",
    "Result": {
        "@type": "Result",
        "Error": [
            {
                "@type": "ErrorDetail",
                "StatusCode": 500,
                "Message": "OFFER CANCELLATION DID NOT COMPLETE. SUPPLIER FAILED TO RESPOND. TRANSACTION IGNORED. RETRY IN A FEW MINUTES. DESTINATION IS DOWN",
                "category": "RETRY",
                "SourceID": "API",
                "SourceCode": "2531"
            }
        ]
    }
    
}

The following example shows the warning message format.

"Result": {
    "@type": "Result",
    "Warning": [
        {
            "@type": "Warning",
            "StatusCode": 99,
            "Message": "Rates unavailable for 50 properties."
        },
        {
            "@type": "Warning",
            "StatusCode": 99,
            "Message": "Images unavailable for 2 properties."
        }
    ]
},

The following table lists the error messages returned in the TripServices Stays APIs for all objects in Error/Result except SourceID, which per above may return API or a supplier code. See the previous section for details on the two types of message returned per the table.