Hotel API · Booking flow
HotelCancellationPolicy()
This function is dedicated to return the hotel cancellation policy of the select offer (room(s))
Request
<HotelCancellationPolicyREQ>
<Credential>
<Login>?</Login>
<Password>?</Password>
</Credential>
<User>?</User>
<Currency>?</Currency>
<Language>?</Language>
<HotelID>?</HotelID>
<FromDate>?</FromDate>
<ToDate>?</ToDate>
<Nationality>XX</Nationality>
<SelectedRooms>
<SelectedRoom id="1">
<Adult>1</Adult>
<Child age="’9’">1</Child>
<Boarding id="?" />
</SelectedRoom>
<SelectedRoom id="2">
<Adult>1</Adult>
<Child>0</Child>
<Boarding id="?" />
</SelectedRoom>
<SelectedRoom id="3">
<Adult>1</Adult>
<Child age="10-12">2</Child>
<Boarding id="?" />
</SelectedRoom>
</SelectedRooms>
</HotelCancellationPolicyREQ>| Root | Sub Root | Description | Valeurs & Format | Tag |
|---|---|---|---|---|
| Credential | Mandatory | |||
| Login | Login | Text | ||
| Password | Password | Text | ||
| User | Current user ID | Numeric | Mandatory | |
| Currency | Cyberesa’s currency ID to be used to calculate prices | Numeric | Mandatory | |
| Language | Cyberesa’s language ID to be used to return suitable texts | Text | Mandatory | |
| HotelID | The selected hotel id | Text | Mandatory | |
| FromDate | Search start date | dd/mm/yyyy | Mandatory | |
| ToDate | Search end date | dd/mm/yyyy | Mandatory | |
| SelectedRooms | SelectedRooms:SelectedRoom:@id | Id of the selected room | Numeric | Mandatory |
| SelectedRooms:SelectedRoom:Adult | Adults number for the current room configuration | Numeric | Mandatory | |
| SelectedRooms:SelectedRoom:child | Number of children for the current room configuration | Numeric | Mandatory | |
| SelectedRooms:SelectedRoom:child @age | Children ages separated by “-” ex: “5” or “5-6” | Text | Mandatory for children | |
| SelectedRooms:SelectedRoom: Boarding:@id | Id of the selected boarding | Numeric | Mandatory | |
| Source | Id of the third-party supplier (if exists) | Numeric | Optional |
Response
<HotelCancellationPolicyRES>
<ErrorResult id="?">
<message>?</message>
</ErrorResult>
<User>?</User>
<Currency>?</Currency>
<NonRefundable>?</NonRefundable>
<TariffNotes>?</TariffNotes>
<CancellationPolicies>
<CancellationPolicy>
<FromDate>?</FromDate>
<Fee>?</Fee>
</CancellationPolicy>
</CancellationPolicies>
<NoShowPolicy>
<Fee>?</Fee>
</NoShowPolicy>
</HotelCancellationPolicyRES>| Racine | Sous racine | Description | Valeurs & Format | Tag |
|---|---|---|---|---|
| ErrorResult | Operation State | |||
| ErrorResult:@id | Id of current error | Numeric | ||
| message | Appropriate message | Text | ||
| User | Current user ID | Numeric | ||
| Currency | Currency code | Numeric | ||
| TariffNotes | Display any comment about the related rate like "You will pay upon arrival a tax charge of XXX for the YY night(s)" or if NRF: "This booking is non-refundable"..etc. | Text | ||
| NonRefundable | Indicate if offer is non refundable | Bool | ||
| CancellationPolicies | CancellationPolicies | |||
| CancellationPolicy :FromDate | CancellationPolicy start date | dd/mm/yyyy | ||
| CancellationPolicy :Fee | Cancellation Policy fee rate | Numeric | ||
| NoShowPolicy | NoShow Policy | |||
| Fee | NoShow policy fee rate | Numeric |