Skip to main content

Alerts

Alerts

Alerts are used by Hotels to communicate messages to the guest.

ParameterDescriptionType
IdId associated with the alertString
NameName of the alertString
TypeType of the alert 
Values: BookingInfo, Hotel, Marketing
String
Details/@attachToReservationIndicates if the alert is stored on the reservation and attached to confirmation emailsBoolean
Details/@DescriptionShort description of the alertString
Details/@DetailedDescriptionDetailed description of the alertString
Details/Validity/@EndEnd date for which the alert appliesString
Details/Validity/@StartStart date for which the alert appliesString
Details/Visibility/@EndEnd date for when the alert should displayString
Details/Visibility/@StartStart date for when the alert should displayString

 

Successful Response (partial)

A successful response will include an optional contentLists/AlertList node containg a list of Alerts if the Request includes content=full.

Additionally, if an Alert is associated to a hotel it will also appear under the productAvailability/AlertList node.

 

{
    "contentLists": {
        "AlertList": [{
            "Details": {
                "AttachToReservation": "Never",
                "Description": "Pool Closed due to renovation",
                "DetailedDescription": "The pool will be closed for renovation.  During this time guests will not be able to enjoy it.",
                "Validity": {
                    "End": "2021-04-14T00:00:00",
                    "Start": "2020-04-14T00:00:00"
                },
                "Visibility": {
                    "End": "2021-04-14T00:00:00",
                    "Start": "2020-04-14T00:00:00"
                }
            },
            "Id": "405d7b4b-065b-4184-a587-d18d73c35d50",
            "Name": "Pool Closed",
            "Type": "Hotel"
        }]
    },
    "productAvailability": {
        "AlertList": [{
            "Id": "405d7b4b-065b-4184-a587-d18d73c35d50"
        }]
    }
}