This transaction is used to determine which rooms and rates are available at a one property. It was developed before the Enhanced Shopping Transaction (EST) and has very similar functionality. The only differences are:
The transaction only returns rate and availability information for one property (EST supports up to 200).
The transaction does not support user-specified timeouts or multipart responses (this is only relevant for EST, which has responses for many properties)
If a property is unavailable, an error will be returned (such as “PID10”) but in the EST transaction, the Property element will be returned with an AvailabilityStatus of “Closed” ( a warning may also be returned to provide additional information).
As this transaction is so similar to the EST transaction, please refer to section 0 for full details of all the rate and availability features.
Simple Usage Example
The example shows a simple request message, with no specific rates are requested.
The following response includes information about the available room and rates. The amount of information returned in this example is fairly basic – other hotels will return more detailed information.
<HotelML xmlns="
http://www.xpegs.com/v2001Q3/HotelML
">
<Head>
<Route Destination="01" Source="00">
<Operation Action="Create" App="TIDispatcher" AppVer="1.12.40.2.8.1.20.4.2.7.12.1.12.2.2.1.8.1.2.6" DataPath="/HotelML" StartTime="2011-06-07T17:17:00.438+00:00" Success="true" TotalProcessTime="425"/>
</Route>
</Head>
<Property xml:lang="en" Code="MC;NYCMQ" Token="1307007312118">
<Rate>
<RatePlan Code="AVA" CommissionableStatus="Commissionable" Description="Best Available rate" InDate="2011-07-01" OutDate="2011-07-04">
<RoomType BookableRate="329.00" Code="00B" NativeCurrency="USD" RateChange="true" RateFrequency="Daily" RoomDescription="Standard Room, 1 King or 2 Double, Sofabed, 430 sqft/39sqm, Wired Internet for a fee, Coffee/te a maker, 42in/107cm LCD TV" TotalRate="957.00" TotalRateInclusive="1108.66">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
</RoomType>
</RatePlan>
<RatePlan Code="AVC" CommissionableStatus="Commissionable" Description="Best Available rate" InDate="2011-07-01" OutDate="2011-07-04">
<RoomType BookableRate="379.00" Code="00B" NativeCurrency="USD" RateChange="true" RateFrequency="Daily" RoomDescription="Times Square View Room, 1 King or 2 Double, Sof abed, 430sqft/39sqm, Wired Internet for a fee, Coffee/tea maker, 42in/107cm LCD TV" TotalRate="1107.00" TotalRateInclusive="1280.78">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
</RoomType>
</RatePlan>
<RatePlan Code="BKC" CommissionableStatus="Commissionable" Description="Stay for Breakfast rate, includes see Rate Rules" InDate="2011-07-01" OutDate="2011-07-04">
<RoomType BookableRate="379.00" Code="00Y" NativeCurrency="USD" RateChange="true" RateFrequency="Daily" RoomDescription="Standard Room, 1 King or 2 Double, Sofabed, 430 sqft/39sqm, Wired Internet for a fee, Coffee/te amaker, 42in/107cm LCD TV" TotalRate="1107.00" TotalRateInclusive="1280.78">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
</RoomType>
</RatePlan>
<RatePlan Code="FNV" CommissionableStatus="Commissionable" Description="Fitness Express Package, see
Rate Rules" InDate="2011-07-01" OutDate="2011-07-04">
<RoomType BookableRate="379.00" Code="00X" NativeCurrency="USD" RateChange="true" RateFrequency="Daily" RoomDescription="Standard Room, 1 King or 2 Double, Sofabed, 430 sqft/39sqm, Wired Internet for a fee, Coffee/te a maker, 42in/107cm LCD TV" TotalRate="1107.00" TotalRateInclusive="1280.78">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
</RoomType>
</RatePlan>
<RatePlan Code="AVK" CommissionableStatus="Commissionable" Description="Best Available rate" InDate="2011-07-01" OutDate="2011-07-04">
<RoomType BookableRate="399.00" Code="00B" NativeCurrency="USD" RateChange="true" RateFrequency="Daily" RoomDescription="Deluxe Corner King Room, 1 King, Sofabed, 460sq ft/41sqm, Living/sitting area, Wired Internet f or a fee, Coffee/tea maker, 42in/107cm LCD TV" TotalRate="1167.00" TotalRateInclusive="1349.63">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
</RoomType>
</RatePlan>
<RatePlan Code="BKD" CommissionableStatus="Commissionable" Description="Stay for Breakfast rate, includes see Rate Rules" InDate="2011-07-01" OutDate="2011-07-04">
<RoomType BookableRate="429.00" Code="00Y" NativeCurrency="USD" RateChange="true" RateFrequency="Daily" RoomDescription="Times Square View Room, 1 King or 2 Double, Sof abed, 430sqft/39sqm, Wired Internet for a fee, Coffee/tea maker, 42in/107cm LCD TV" TotalRate="1257.00" TotalRateInclusive="1452.91">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
</RoomType>
</RatePlan>
<RatePlan Code="EGC" CommissionableStatus="Commissionable" Description="Regular rate" InDate="2011-07-
01" OutDate="2011-07-04">
<RoomType BookableRate="629.00" Code="00R" NativeCurrency="USD" RateChange="true" RateFrequency="Daily" RoomDescription="Deluxe Suite, 1 King or 2 Double, Sofabed, Mini -fridge, 567sqft/51sqm, Living/sitting area, Li ving room is separated, Wired Internet for a fe" TotalRate="1857.00" TotalRateInclusive="2141.41">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
</RoomType>
</RatePlan>
<RatePlan Code="EGI" CommissionableStatus="Commissionable" Description="Regular rate" InDate="2011-07-
01" OutDate="2011-07-04">
<RoomType BookableRate="679.00" Code="00R" NativeCurrency="USD" RateChange="true" RateFrequency="Daily" RoomDescription="Executive Suite, 1 King, Sofabed, Mini-fridge, 567sqft/51sqm, Living/sitting area, Dining area , Living room is separated, Wired Internet for" TotalRate="2007.00" TotalRateInclusive="2313.53">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
</RoomType>
</RatePlan>
<RatePlan Code="A00" CommissionableStatus="Commissionable" Description="AAA rate, AAA membership card required" InDate="2011-07-01" OutDate="2011-07-04">
<CorpInfo Code="AAA"/>
<RoomType BookableRate="329.00" Code="QAZ" NativeCurrency="USD" RateChange="true" RateFrequency="Daily" RoomDescription="Standard Room, 1 King or 2 Double, Sofabed, 430 sqft/39sqm, Wired Internet for a fee, Coffee/te a maker, 42in/107cm LCD TV" TotalRate="957.00" TotalRateInclusive="1108.66">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
</RoomType>
</RatePlan>
<RatePlan Code="I00" CommissionableStatus="Commissionable" Description="AAA Promotion, AAA
membership card required, see Rate Rules" InDate="2011-07-01" OutDate="2011-07-04">
<CorpInfo Code="AAA"/>
<RoomType BookableRate="341.00" Code="TDG" NativeCurrency="USD" RateChange="true" RateFrequency="Daily" RoomDescription="Times Square View Room, 1 King or 2 Double, Sof abed, 430sqft/39sqm, Wired Internet for a fee, Coffee/tea maker, 42in/107cm LCD TV" TotalRate="996.00" TotalRateInclusive="1153.41">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
</RoomType>
</RatePlan>
<RatePlan Code="F00" CommissionableStatus="Commissionable" Description="AAA rate, AAA membership card required" InDate="2011-07-01" OutDate="2011-07-04">
<CorpInfo Code="AAA"/>
<RoomType BookableRate="379.00" Code="QAZ" NativeCurrency="USD" RateChange="true" RateFrequency="Daily" RoomDescription="Deluxe Corner King Room, 1 King, Sofabed, 460sq ft/41sqm, Living/sitting area, Wired Internet f or a fee, Coffee/tea maker, 42in/107cm LCD TV" TotalRate="1109.00" TotalRateInclusive="1283.08">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
</RoomType>
</RatePlan>
<RatePlan Code="O00" CommissionableStatus="Commissionable" Description="Explore Your New York, includes see Rate Rules" InDate="2011-07-01" OutDate="2011-07-04">
<CorpInfo Code="ES2"/>
<RoomType BookableRate="404.00" Code="ECE" NativeCurrency="USD" RateChange="true" RateFrequency="Daily" RoomDescription="Standard Room, 1 King or 2 Double, Sofabed, 430 sqft/39sqm, Wired Internet for a fee, Coffee/te amaker, 42in/107cm LCD TV" TotalRate="1182.00" TotalRateInclusive="1366.84">
<GuaranteePolicy Required="true"/>
<CancelPolicy IntervalUnits="Days" TimeInterval="1"/>
</RoomType>
</RatePlan>
</Rate>
</Property>
</HotelML>
No Availability Example
The following is an example response for a property that has no availability for the specified criteria:
It is possible to request the room, rate and policy descriptions (from the hotel’s CRS) to be returned in a specific language. An example of requesting a response in German is shown below:
If the room rate information in the hotel’s CRS is not available in the requested language, the hotel should return their room rate descriptions in English and indicate that in the language indicator field being returned to the affiliate.
The following example shows a response to a request for Spanish (“es”). The room rate descriptions are not available in Spanish and so are returned in English.
There is one exception to the above rule, which is that if the affiliate is configured to accept response messages in ‘unmatched’ languages (i.e. not the requested language or English) then the response will be in whichever language the hotel’s CRS has provided. The language returned will be indicated in the response using the XML: lang attribute.
If the affiliate decides not to support this option (it is configurable by RateGain), any time a hotel responds with a language indicator that does not match the requested language code or is not English, an error message will be returned. An example is below:
<HotelML xmlns="
http://www.xpegs.com/v2001Q3/HotelML
">
<Head>
<Route Destination="01" Source="00">
<Operation Action="Create" App="TIDispatcher" AppVer="1.12.40.1" DataPath="/HotelML" StartTime="2011-07-
31T20:15:11.143+00:00" Success="true" TotalProcessTime="99"/>
</Route>
<Error Code="RLC10" Description="The returned language code does not match the language that was originally requested" Type="Process"/>
</Head>
<Property xml:lang="en" Code="XX;1234" Token="1152642043909"/>
</HotelML>
