Versions Compared

Version Old Version 2 New Version Current
Changes made by

Yana Brilevskaya

Yana Brilevskaya

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: HUB-11297 Added new value "Prefix" to RequiredGuestDetail/@Type

Hotel Booking Rule Response contains room rate information, information about the cancellation policy, and a list of required information to complete booking.

OTA_HotelBookingRuleRS*:

*mandatory

Element

Attribute

Type

Description

Min…Max occurs

Element

Attribute

Type

Description

Min…Max occurs

Success

For more information see Common Data Description section in Glossary.

Warnings/Warning

RuleMessage*

 

 

Unite Unites all information about booking rules of for the chosen offer.

1…1

RuleMessage/StatusApplication*

 

 

Represents basic information about offer.

 1...1

RuleMessage/BookingRules/BookingRule*

 

 

Represents main information about offer rulesthe offer.

 1...1

OTA_HotelBookingRuleRS/RuleMessage/StatusApplication*:

BookingCode*

string

Must be equal to BookingCode from the availability response.

1...1

RuleMessage/StatusApplication/RoomRates/RoomRate*

 

 

Contains basic information about the offer.

1…*

Amount*

decimal

The price after taxes, if any has been applied.

1...1

Start*

yyyy-mm-dd

Defines start day of stay.

1...1

End*

yyyy-mm-dd

Defines end day of stay.

1...1

CurrencyCode*

string

For more information see Common Data Description section in Glossary.

1...1

RuleMessage/BookingRules/BookingRule*

 

 

Represents main information about offer rules.

 1...1

OTA_HotelBookingRuleRS/RuleMessage/BookingRules/BookingRule*:

Element

Attribute

Type

Description

Min…Max occurs

CancelPenalties/CancelPenalty

 

 Describes

penalties on booking cancellationFor more information see Hotel Availability Response section.

0...*

Description

 

 

Collection Contains a collection of offer descriptions.

0...*

Name

String

Name of description.

0...1

Description/Text

 

String

Offer description.

0…1

RequiredGuestDetails*

 

 

A collection of required guest details that are part of the booking requirements.

1…1

RequiredGuestDetails/Guest*

 

 

Represent Represents guest detail details for concrete the specific guest.

 

AgeQualifyingCode*

 

For more information see Common Data Description section in Glossary.

1...1

PrimaryIndicator*

boolean

Indicate Indicates is required information provided for the tour lead or not.

1...1

Age

integer (0 - 150)

Represent Represents the age of the guest.

0…1

RequiredGuestDetails/Guest/RequiredGuestDetail*

 

 

Collection of required guest details.

1...*

Type*

String

Name of the required detail. Possible values are: GivenName, Surname, BirthDate, Email, DocumentNumber, DocumentType, PhoneNumber, AddressLine, CityName, CountryName, PostalCode, CitizenCountryName, Prefix.

1...1

Expand
titleHotel Booking Rule Response Sample XML
Code Block
languagexml
<OTA_HotelBookingRuleRS xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="Token" Version="2.0">
    <Success/>
    <RuleMessage>
        <StatusApplication BookingCode="1001">
            <RoomRates>
                <RoomRate Amount="140.00" CurrencyCode="USD" End="2024-09-02" Start="2024-09-01"/>
            </RoomRates>
        </StatusApplication>
        <BookingRules>
            <BookingRule>
                <CancelPenalties>
                    <CancelPenalty End="2024-09-01T00:00:00" Start="2024-04-11T00:00:00">
                        <AmountPercent Amount="140.00" CurrencyCode="USD" Percent="100"/>
                        <PenaltyDescription>
                            <Text>Non refundable</Text>
                        </PenaltyDescription>
                    </CancelPenalty>
                </CancelPenalties>
                <Description Name="Non Refundable Room">
                    <Text>Non Refundable Room</Text>
                </Description>
                <RequiredGuestDetails>
                    <Guest AgeQualifyingCode="10" PrimaryIndicator="true">
                        <RequiredGuestDetail Type="Surname"/>
                        <RequiredGuestDetail Type="GivenName"/>
                        <RequiredGuestDetail Type="Age"/>
                    </Guest>
                    <Guest AgeQualifyingCode="10" PrimaryIndicator="false">
                        <RequiredGuestDetail Type="AgeBirthDate"/>
                    </Guest>
                </RequiredGuestDetails>
            </BookingRule>
        </BookingRules>
    </RuleMessage>
</OTA_HotelBookingRuleRS>