Breadcrumb
- Hotel Availability
- Response
- Examples
- Alerts
Alerts
Alerts
Alerts are used by Hotels to communicate messages to the guest.
Parameter | Description | Type |
---|---|---|
Id | Id associated with the alert | String |
Name | Name of the alert | String |
Type | Type of the alert Values: BookingInfo, Hotel, Marketing | String |
Details/@attachToReservation | Indicates if the alert is stored on the reservation and attached to confirmation emails | Boolean |
Details/@Description | Short description of the alert | String |
Details/@DetailedDescription | Detailed description of the alert | String |
Details/Validity/@End | End date for which the alert applies | String |
Details/Validity/@Start | Start date for which the alert applies | String |
Details/Visibility/@End | End date for when the alert should display | String |
Details/Visibility/@Start | Start date for when the alert should display | String |
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"
}]
}
}