Sample Transaction Flows > Transaction Flow 1 > Step 1 > Step 2 > Step 3 > Step 4


Sample Hotel Transaction Flow 1

Step 3: Requesting a Complete Hotel Availability

Description

Business Process

From the list of responses in the hotel index, the user selects a specific property.

Client Activity

The client application uses the RoomMaster Property ID for the selected property to perform a complete availability, which returns a list of all available rates for that property.

Task

Requesting a Complete Hotel Availability

Returns a comprehensive list of properties for a specified location, regardless of availability. City codes or references points can be used to define the location.

Associated Web Service (GWS Only)

XML Select Web Service

Associated XML Transaction:

HotelCompleteAvailability_11

Recommended Use

Required to reserve a hotel segment, unless the segment is booked as a direct sell.

Complete availability can be used as the first hotel booking task, if the RoomMaster Property ID is already known. However, in many hotel business processes, a hotel index or standard hotel availability task is used first to select a property or obtain the RoomMaster Property ID.

Sample Request and Response

To view the request sample without annotation, go to the unannotated version.

Request

The Hotel Complete Availability transaction request.

<HotelCompleteAvailability_11>

The primary complete availability request element.

<HotelCompleteAvailabilityMods>

Required. Hotel stay and property information. Vendor codes, RoomMaster Property ID, and other property information can be retrieved from a previous hotel index or standard availability response.

<HotelInsideAvailability>

The check-in date in CCYYMMDD format.

<ArrivalDt>20050724</ArrivalDt>

The check-out date in CCYYMMDD format.

<DepartureDt>20050728</DepartureDt>

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

<NumNights>4</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.

<NumAdults>1</NumAdults>

The chain code of the selected hotel property.

<Vnd>KC</Vnd>

The RoomMaster ID of the property.

<RMNum>83479 </RMNum>

Alternate Availability indicator.

Y = Include alternate availabilities in response, if available.

N or blank = Do not alternate availabilities in the response.

<AltAvailInd>N</AltAvailInd>

RoomMaster Only indicator.

Y = Data is returned only from RoomMaster.

N = Data returned either from RoomMaster or the vendor (if the property is an Inside Availability participant). Default value.

<RMOnlyInd>N</RMOnlyInd>

Indicates if the search criteria specified in the slot array can be relaxed to return at least one property.

Y = Relax
M = Mandatory, no relax

<NoRelaxInd>Y</NoRelaxInd>

The currency code used by the vendor or stored in RoomMaster.

<StoredCrncy>USD</StoredCrncy>

The number of places in the vendor or stored currency.

<NumDecStoredCrncy>2
</NumDecStoredCrncy>

Returns the room rates in a desired alternate currency, in addition to the currency that the room rate is stored in by RoomMaster or the hotel vendor. In this example, the currency code requests rates to be provided in Moldovan lei, in addition to the stored currency for the property (US dollars).

If the client application has a Euro default defined in the Galileo or Apollo AAA, and this value is blank, then the alternate currency is automatically returned in Euros for properties in participating EU countries. An N value can override the Euro default and return the rate only in the stored currency.

<AltCrncy>MDL</AltCrncy>

The number of places in the alternate currency.

<NumDecAltCrncy>2</NumDecAltCrncy>

The number of places in the alternate currency.

</HotelInsideAvailability>

Any slot data included in the request must be identical to the slot data provided in any previous requests for a hotel index (Step 2) or a standard hotel availability.

<HotelSlotData>

<SlotIDAry>

<SlotID>

<ID>E</ID>

<Priority>1</Priority>

<Data>3</Data>

</SlotID>

<SlotID>

<ID>A</ID>

<Priority>2</Priority>

<Data>46</Data>

</SlotID>

<SlotID>

<ID>A</ID>

<Priority>2</Priority>

<Data>50</Data>

</SlotID>

</SlotIDAry>

</HotelSlotData>

Ends the request.

</HotelCompleteAvailabilityMods>

</HotelCompleteAvailability_11>

Sample Response

The complete hotel availability response.

<HotelCompleteAvailability_11>

Indicates a complete hotel availability response (indicated because the CRS uses the same structures to process other types of hotel transactions.

<HotelCompleteAvailabilityMods>

The type of response. Responses for complete availability are:
I
= Inside Availability response to a HotelCompleteAvailability request.
E = Error message.
R = RoomMaster response.
A = Alternate Availability response.

<HotelType>

<HtlTypeInd>I</HtlTypeInd>

</HotelType>

Begins the hotel property header.

<HotelPropHeader>

The three-letter city code.

<City>CHI </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/>

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

<RefPtPostalInd/>

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

<State/>

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

<MileKmInd/>

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

<CityCodeRefMatch/>

 

</HotelPropHeader>

Begins the hotel availability header.

<HtlAvailHeader>

 

<CatInd/>

The check-in date in CCYYMMDD format.

<StartDt>20050724 </StartDt>

The check-out date in CCYYMMDD format.

<EndDt>20050728 </EndDt>

The number of nights for the hotel stay.

<NumNights>4</NumNights>

The number of adult travelers in the room.

<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>

Begins the property record for the hotel. Optional data in this element is typically determined by the vendor. Therefore, various chains or properties may provide different information.

<HotelPropertyRecord>

The two-character vendor chain code.

<Vnd>KC </Vnd>

The RoomMaster Property number.  

<RMID>83479 </RMID>

The short property name.

<PropName>HTL ALLEGRO CHICAGO </PropName>

The short property address.

<ShortAddr/>

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

<Dist>0 </Dist>

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

<Dir/>

The primary location of the property.
C = City
A = Airport
R = Resort
S = Suburban

<Locn/>

One of the legal transportation types associated with the property
C = Courtesy Car
L = Limousine
O = Check with hotel
P = Public transportation
W = Walking distance

<Transportation/>

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

<InsideLinkInd>I </InsideLinkInd>

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 properties is featured property advertiser.
Y = Featured property advertiser
N or blank = Not a featured property

<Advertiser/>

 

</HotelPropertyRecord>

Vendor marketing message, if available. Only returned with Inside Availability. Blank if no message or Inside Availability.

<HotelVendorMarketing>

<VMsg>EXPLORE OUR UNIQUE BOUTIQUE HOTELS</VMsg>

</HotelVendorMarketing>

Currency parameters for this property/request.

<HotelCurrency>

The currency code for US dollars, 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.

<StoredCrncy>USD </StoredCrncy>

The number of decimal points in the stored currency.

<StoredDecPos>2 </StoredDecPos>

The alternate currency code in Moldovan lei. Alternate currencies are specified in the request.

<AltCrncy>MDL </AltCrncy>

The number of decimal points in the alternate currency.

<NumDecs>2 </NumDecs>

 

</HotelCurrency>

The first available room rate for the property.

<HotelRate>

The stored or vendor currency.

<StoredCrncy>USD </StoredCrncy>

The number of decimal points in the stored currency.

<StoredNumDec>2 </StoredNumDec>

Indicates if there are more rates for this property in the response.
Y = More rates exist. A More token can be used to request the additional data.
N = No more rates exist.

<MoreRatesInd>N </MoreRatesInd>

Indicates the source of the room rates.

Y = Rates stored at vendor location only (if the property has Inside Availability)

N or blank = Rates also stored in RoomMaster

<IARatesOnlyInd/>

Indicates the availability status:
N = Need status
S =OK to sell

<AvailNeedInd/>

Indicates if taxes are included in the rate.
T = Includes taxes
blank
= Does not include taxes

<TaxInd/>

Indicates if the rate changes during the length of stay.
Y = Rate changes
N or blank = No rate changes

<RateChgInd/>

Indicates if the room is available by request only from the vendor:
Y = Room only available on request

N = Room available

<RoomByReq/>

The rate category, if a category was included in the request parameters.

<RateCatInd/>

The rate code shown to a travel provider. This code is not typically displayed to the traveler.

<DispRate>A06 </DispRate>

The room rate in the stored or vendor currency, with the number of implied decimals associated with that currency (1042.50 NOK).

<VStoredRateAmt>15900 </VStoredRateAmt>

The Booking Indicator Code for this rate. Required to sell the segment and display rate rules.

<BIC>A06A0I </BIC>

Rate Guarantee Indicator.
Y = Rate is guaranteed
N = Rate is not guaranteed

<RateGuarInd/>

 

</HotelRate>

The rate information in the requested alternate currency.

<HotelAlternateRates>

<AltCrncy>MDL </AltCrncy>

<NumDec>2 </NumDec>

<AltRateGuarInd/>

<AltRateAmt>222123 </AltRateAmt>

</HotelAlternateRates>

Description text for the room rate provided by the vendor. Up to 47 characters per <Desc> value.

<HotelRateDescription>

 

<Desc>SAVER RATE </Desc>

 

</HotelRateDescription>

 

<HotelRateDescription>

 

<Desc>KING ROOM WITH IN ROOM FAX DATAPORT MINIBAR </Desc>

 

</HotelRateDescription>

 

<HotelRateDescription>

 

<Desc>2 LINE SPEAKER PHONES CD PLAYER VOICE MAIL </Desc>

 

</HotelRateDescription>

The second room rate in the response.

<HotelRate>

<StoredCrncy>USD </StoredCrncy>

<StoredNumDec>2 </StoredNumDec>

<MoreRatesInd>N </MoreRatesInd>

<IARatesOnlyInd/>

<AvailNeedInd/>

<TaxInd/>

<RateChgInd/>

<RoomByReq/>

<RateCatInd/>

<DispRate>A00 </DispRate>

<VStoredRateAmt>15900 </VStoredRateAmt>

<BIC>A00A0I </BIC>

<RateGuarInd/>

</HotelRate>

<HotelAlternateRates>

<AltCrncy>MDL </AltCrncy>

<NumDec>2 </NumDec>

<AltRateGuarInd/>

<AltRateAmt>222123 </AltRateAmt>

</HotelAlternateRates>

<HotelRateDescription>

<Desc>SAVER RATE </Desc>

</HotelRateDescription>

<HotelRateDescription>

<Desc>DOUBLE DOUBLE IN ROOMS FAX DATAPORT MINIBAR </Desc>

</HotelRateDescription>

<HotelRateDescription>

<Desc>2 LINE SPEAKER PHONES CD PLAYER VOICE MAIL </Desc>

</HotelRateDescription>

Additional rates are listed.

....

Ends the complete hotel availability response.

</HotelCompleteAvailability>

</HotelCompleteAvailability_11>