Sample Hotel Transaction Flow 2

The HotelAvailability transaction request.

<HotelAvailability_12>

The primary standard availability request element.

<AvailabilityRequestMods>

Begins the request header.

<HotelRequestHeader>

The check-in date in CCYYMMDD format.

<StartDt>20040517</StartDt>

The check-out date in CCYYMMDD format.

<EndDt>20040522</EndDt>

The city code for the request.

<City>SKE</City>

A reference point or postal code, which narrows the index search. If no reference point is used, the data is blank filled. Optional. This example does not use a reference point.

<RefPt></RefPt>

Indicates if the search criteria specified in the slot array can be relaxed to return at least one property. Always set to blank.
Y = Relax
M = Mandatory, no relax

<NoRelaxInd>Y</NoRelaxInd>

The desired or alternate currency. Responses can include rates in the stored/vendor currency, and an alternate preferred currency.

<DesiredAltCrncy>USD

</DesiredAltCrncy>

</HotelRequestHeader>

Begins the hotel request.

<HotelRequest>

Because the <HotelRequest> element is used in several types of hotel transactions, the type of transaction must be indicated. For standard hotel availabilities, the following types of requests are used:
C = Generic unbiased
F = Filtered hotel availability
T = TravelScreen
U = Standard featured property (restricted use)

<ReqInd>C</ReqInd>

The number of nights for the stay. The maximum is 99.

<NumNights>5</NumNights>

The number of adult travelers in the room. The maximum is 9.

Additional adults, additional children, or additional rooms can be added in the hotel sell request.

<NumPersons>2</NumPersons>

Ends the request.

</HotelRequest>

</AvailabilityRequestMods>

</HotelAvailability_12>

Begins the standard hotel availability response.

<HotelAvailability_12>

The primary hotel availability element.

<HotelAvailability>

The type of response. For standard hotel availability responses, the following response types apply:
P = Property List returned.
S = Similar Name List returned.
E = Error message returned.

<HotelType>

<HtlTypeInd>P </HtlTypeInd>

</HotelType>

The hotel property header describes the response parameters.

<HotelPropHeader>

Three-character city code for the city.

<City>SKE</City>

The reference point or postal code from the request. If no <ReferencePoint> value is specified in the request, as in this example, the default location is the airport for the request cities.

<HtlRefPt>SKIEN ARPT </HtlRefPt>

Reference point or postal code indicator describes the type in <HtlRefPt>.
P = Postal Code
R = Reference Point

<RefPtPostalInd>R</RefPtPostalInd>

The US state or Canadian province code. Blank for other countries.

<State/>

Unit of measure for distances.
M = Miles
K = Kilometers

<MileKmInd>M </MileKmInd>

If reference points are used, indicates if the city code and reference point name match.  

Y = City code and reference name match.

N = No match. For example, user requests for "MILE HIGH STADIUM" in FLL. A warning should be given to the user.

<CityCodeRefMatch>Y </CityCodeRefMatch>

</HotelPropHeader>

Begins the hotel availability header.

<HtlAvailHeader>

The type of response, based on the request type indicator, <ReqInd>, used in the request.
T = TravelScreen
C = Generic unbiased
U = Standard Spectrum
F = Filtered Availability (Data Store only)

<CatInd>C</CatInd>

The check-in date in CCYYMMDD format.

<StartDt>20040517</StartDt>

The check-out date in CCYYMMDD format.

<EndDt>20040522</EndDt>

The number of nights for the stay. The maximum is 99.

<NumNights>5</NumNights>

The number of adult travelers in the room. The maximum is 9.

Additional adults, additional children, or additional rooms can be added in the hotel sell request.

<NumPersons>2</NumPersons>

The number of preferred properties in the response. Applies only to TravelScreen requests, blank for all other request types.

<PrefPropCnt/>

Indicates whether a neutral availability is returned for the response properties, or if the response properties are returned based on preferences in the request. Applies only to TravelScreen or Filtered Availability responses with a <CatInd> value of T or F.

Y = Neutral Availability returned. No match on preferences found.

N = Neutral Availability not returned.

Blank = Not a Travelscreen or Filtered Availability response.

<NeutralAvailInd/>

</HtlAvailHeader>

The total number of property items that are returned in this response. Up to 14 properties can be returned in a standard hotel availability response. If additional properties are available, a More token can be used to retrieve those properties.

<HotelPropertyListCount>

<TotCnt>8</TotCnt>

</HotelPropertyListCount>

Data for the first property response.

<HotelInsideShopProperty>

Line number in the display for this property. This data is typically used for display by non-parsing applications.

<LineNum>1</LineNum>

The two-character vendor chain code.

<Vnd>SX</Vnd>

Indicates the availability for the property.

A = Request is available within date range.

C = Request is not available for dates requested.

O = Property is available, but not for the rates requested.

<PropInd>A</PropInd>

The RoomMaster Property number.

<PropNum>15588</PropNum>

The short property name.

<PropName>RICA IBSEN HOTEL </PropName>

The long property name.

<PropFullName>RICA IBSEN HOTEL </PropFullName>

The short property address.

<Addr>KONGSGT 33 SKIEN </Addr>

Distance from reference point to the property. Defaults to the city center if no reference is given, as in this example.

<Dist>3</Dist>

The direction from city center or reference point to the property.

<Dir>W</Dir>

One of the legal transportation types associated with the property, if available.
C = Courtesy car
L = Limo
O = Check with hotel
P = Public transportation
W = Walking distance , if available.

<TransportInd/>

The primary city code.

<City>OSL</City>

Indicates if the property is a Spectrum advertiser.
Y = participant
N = non-participant

<SpectrumAdvertInd>N
</SpectrumAdvertInd>

Indicates the participation level for the property.
L = Link partner
I = Inside Availability Link
R = RoomMaster only participant
S = Inside Shopper participant

<LinkInd>S</LinkInd>

The AAA rating for the property: 1 to 5 Diamonds.

The AAA rating can be used in requests, and corresponding responses will be based on the AAA rating, when available. However, the rating only displays in the availability displays in the response only by special agreement.

<AAARating/>

Indicates if the property is an Inside Shopper participant. Required for a subsequent complete hotel availability transaction.

<InsideShopInd>Y</InsideShopInd>

Deposit requirements for check-in.

G = Guarantee required

D = Deposit required to hold room

01-12 = The hour for late check-in without requiring guarantee. The time is based on a 12-hour clock with PM hours only.

In this example, the deadline for check-in without guarantee is 6:00 PM.

<DepInd>06</DepInd>

The currency code for Norwegian kroner, associated with property, which is used to build <HotelInsideShopRate> items.

The currency code is typically the local currency. However, some properties may use a non-local currency as their currency.

<Crncy>NOK</Crncy>

Ends the property description.

</HotelInsideShopProperty>

The alternate currency for the property, as included in the request.

<HotelAlternateCurrency>

The alternate currency code, US dollars.

<AltCurrency>USD </AltCurrency>

The number of decimal points in the currency.

<NumDec>2</NumDec>

The lowest available rate amount for this property.

Note: Previous versions of HotelAvailability provided up to 8 booking codes for room rates in the response. This version of HotelAvailability provides highest and lowest available rates for properties.

<LowRate>18632</LowRate>

The highest available rate amount.

<HighRate>18632</HighRate>

</HotelAlternateCurrency>

The room rates in the property's currency.

<HotelInsideShopRate>

The currency code.

<Crncy>NOK</Crncy>

The number of decimal points in the currency.

<NumDec>2</NumDec>

The tax indicator.

Y = Tax is included.

blank = Tax is not included.

<TaxInd/>

Y = Rate is on request.
N = Rate is not on request.

<LowRateReqInd>N</LowRateReqInd>

The rate change indicator.
Y = Rate changes during stay.
N = No rate changes during stay .

<LowRateChgInd>N</LowRateChgInd>

The lowest available rate amount for the desired rate category. If no rate category or mult-level rate is specified, the low rate will be the lowest rate of all non-credentialed rates (rate categories R, B, C, W, L, and P).

Note: Previous versions of HotelAvailability provided up to 8 booking codes for room rates in the response.

<LowRateAmt>133000</LowRateAmt>

Y = Rate is on request.
N = Rate is not on request.

<HighRateReqInd>N</HighRateReqInd>

The rate change indicator.
Y = Rate changes during stay.
N = No rate changes during stay.

<HighRateChgInd>N</HighRateChgInd>

The highest available rate amount for desired category.

<HighRateAmt>133000</HighRateAmt>

</HotelInsideShopRate>

Data for the second hotel property.

<HotelInsideShopProperty>

<LineNum>2</LineNum>

<Vnd>GT</Vnd>

<PropInd/>

<PropNum>84814 </PropNum>

<PropName>GT RAINBOW HOYERS H </PropName>

<PropFullName>GT RAINBOW HOYERS HOTEL SKIEN </PropFullName>

<Addr>KONGENSGT 6 </Addr>

<Dist>5 </Dist>

<Dir>SW </Dir>

<TransportInd>O </TransportInd>

<City>SKE </City>

<SpectrumAdvertInd>N </SpectrumAdvertInd>

<LinkInd>I </LinkInd>

<AAARating/>

<InsideShopInd>N </InsideShopInd>

<DepInd>06 </DepInd>

<Crncy>NOK </Crncy>

</HotelInsideShopProperty>

Alternate currency rates data for the second hotel property.

<HotelAlternateCurrency>

<AltCurrency>USD </AltCurrency>

<NumDec>2 </NumDec>

<LowRate>9386 </LowRate>

<HighRate>20593 </HighRate>

</HotelAlternateCurrency>

Rate information for the second hotel property, in the stored or property currency.

<HotelInsideShopRate>

<Crncy>NOK </Crncy>

<NumDec>2 </NumDec>

<TaxInd>T </TaxInd>

<LowRateReqInd>N </LowRateReqInd>

<LowRateChgInd>N </LowRateChgInd>

<LowRateAmt>67000 </LowRateAmt>

<HighRateReqInd>N </HighRateReqInd>

<HighRateChgInd>N </HighRateChgInd>

<HighRateAmt>147000 </HighRateAmt>

</HotelInsideShopRate>

Data for the third hotel property.

<HotelInsideShopProperty>

<LineNum>3 </LineNum>

<Vnd>CI </Vnd>

<PropInd/>

<PropNum>37459 </PropNum>

<PropName>COMFORT HOTEL BRYGG </PropName>

<PropFullName>COMFORT HOTEL BRYGGEPARKEN </PropFullName>

<Addr>LANGBRYGGEN 8 </Addr>

<Dist>5 </Dist>

<Dir>SW </Dir>

<TransportInd>O </TransportInd>

<City>SKE </City>

<SpectrumAdvertInd>N </SpectrumAdvertInd>

<LinkInd>I </LinkInd>

<AAARating/>

<InsideShopInd>N </InsideShopInd>

<DepInd>G </DepInd>

<Crncy>NOK </Crncy>

</HotelInsideShopProperty>

Alternate currency rates data for the third hotel property.

<HotelAlternateCurrency>

<AltCurrency>USD </AltCurrency>

<NumDec>2 </NumDec>

<LowRate>14604 </LowRate>

<HighRate>23956 </HighRate>

</HotelAlternateCurrency>

Rate information for the third hotel property, in the stored or property currency.

<HotelInsideShopRate>

<Crncy>NOK </Crncy>

<NumDec>2 </NumDec>

<TaxInd>T </TaxInd>

<LowRateReqInd>N </LowRateReqInd>

<LowRateChgInd>N </LowRateChgInd>

<LowRateAmt>104250 </LowRateAmt>

<HighRateReqInd>N </HighRateReqInd>

<HighRateChgInd>Y </HighRateChgInd>

<HighRateAmt>171000 </HighRateAmt>

</HotelInsideShopRate>

A total of eight properties are listed in the response. For brevity, only three properties are annotated in this example.

....

A More token can be used to request additional available properties that were not listed in this response.

In this example, there are no additional properties that meet the request parameters because the <MoreInd> value is No.

<HotelGetMore>

<StartDBKey>1193268</StartDBKey>

<EndDBKey>1193271</EndDBKey>

<RefPtDBKey>239923997</RefPtDBKey>

<BitMap>1111111111111111</BitMap>

<TotNumProps>8</TotNumProps>

<SubtotalNumPropsRet>0
</SubtotalNumPropsRet>

<MoreInd>N</MoreInd>

<DBPropTok>00000000</DBPropTok>

<DBPropKey>0</DBPropKey>

</HotelGetMore>

Ends the request.

</HotelAvailability>

</HotelAvailability_12>