This task is used to request a list of properties associated with a specified location, reference point or postal code that does not consider whether a property is available or not.
Transaction Name:
HotelIndex_9
Can any other transactions perform this same task?
HotelIndex_9 will return all properties within the given search criteria, regardless of availability. If availability needs to be checked, a version of Hotel Availability, such as HotelAvailability_12, should be used.
Can this task be performed in a sessionless environment?
This task can be performed in both sessioned and sessionless environments.
Are the request and response identical on both the Apollo and Galileo systems?
Apollo and Galileo are identical.
List any industry-specific knowledge required to understand this task.
The end user must understand the difference between a Hotel Index request (availability is not checked) and a Hotel Availability request.
Explain any special limits or distinct restrictions.
No limits or restrictions on input data.
Request:
Unless otherwise specified, use ALL CAPS in any request data.
A hotel index request requires <HotelHeader> and <HotelRequest> elements, which provide request parameters such as dates, location, and search qualifiers.
A <Control> element that lists all of the structures is also required for HotelIndex_9. The KLR array <KlrAry> in <Control> lists the number and type of data structures known as KLRs in the request. The version number is not required. The Galileo-proprietary name for the KLRs must be used:
<HotelRequestHeader> = HT01
<HotelRequest> = HT02
<HotelGetMore> = HTGM
<HotelPropertyNumList> = HTPN
<HotelSlotData> = HTSL
Several optional elements can be added to the main request. If additional properties are requested through a More token, a <HotelGetMore> element is required. If search qualifiers are added to the request, a <HotelSlotData> element is required.
Prerequisite tasks:
No prerequisites are required for a hotel index. However, a hotel reference point request may be made to retrieve reference points for a city or metropolitan area. The reference point can subsequently be used as the location in the index request.
Expected response:
Responses vary, depending on the request parameters. All responses contain <HotelType>, which contains the type of response (property list, similar names list, or error response).
Standard responses that include a property list contain the following elements:
- <HtlIndexRate> with stored rate information. Required.
- <HotelPropertyGeocode> with the latitude and longitude of the property. Optional. Property latitude and longitude information is for internal Galileo use only and is not currently available via external structured data or xml. Please disregard this tag.
A similar names response contains a <HotelType> element followed by a <HotelSimilarNames> element.
Error and warning responses:
Extensive errors can occur in the Hotel Index processing path and can vary with the data record version used. <HotelError> or <ErrorTxt> are returned when an error condition occurs, depending on the point of failure. A complete list of errors is not available at this time.
See the Hotel Error Messages table to see all hotel errors.
Follow-on requests:
Often additional information is desired about the property or chain. A HotelDescription_5_0 request can be made, at either the property or chain level, using the property number, date information, and vendor chain code.
To check availability for a property returned, a version of the HotelCompleteAvailability_11 request can be called. The RoomMaster property number and chain code of the property, as well as date information, are required.
|
<HotelIndexMods> |
Terminal Equivalents: |
Apollo: HOI |
Galileo:HOI |
|
Ordering |
KLR |
Min/Max |
XML Tag |
|
|
HT01 |
1 - 1 |
<HotelRequestHeader> |
| HT02 | 1 - 1 | <HotelRequest> | |
| HTGM | 0 - 1 | <HotelGetMore> | |
| HTPN | 0 - 1 | <HotelPropertyNumList> | |
| HTSL | 0 - 1 | <HotelSlotData> | |
| HREQ | 0 - 1 | <HotelExtras> | |
| HACQ | 0 - 1 | <HotelChildren> |
|
<HeadlineAd> |
|
|
Ordering |
NWB |
Min/Max |
XML Tag |
|
|
5501 | 0 – 1 | <HeadlineAd> |
|
<HotelIndex> |
|
|
Ordering |
KLR |
Min/Max |
XML Tag |
|
|
CTRL | 1 – 1 | <Control> |
| EROR | 0 – 1 | <ErrText> | |
| HIRT | 1 – 45 | <HtlIndexRate> | |
| HTCB | 0 – 1 | <HotelChainBrochure> | |
| HTCS | 0 – 1 | <HotelChainSearchStatus> | |
| HTER | 0 – 1 | <HotelError> | |
| HTGC | 1 – 45 | <HotelPropertyGeocode> | |
| HTGM | 0 – 1 | <HotelGetMore> | |
| HTPH | 1 – 1 | <HotelPropHeader> | |
| HTPL | 1 – 1 | <HotelPropertyListCount> | |
| HTPR | 1 – 45 | <HotelPropertyRecord> | |
| HTPS | 1 – 1 | <HotelPropertyStatus> | |
| HTSN | 0 – 1 | <HotelSimilarNames> | |
| HTTD | 0 – 1 | <HtlTravelScreenData> | |
| HTTG | 0 – 1 | <HtlGeneralPreferences> | |
| HTTP | 0 – 1 | <HtlPreferences> | |
| HTTR | 1 – 1 | <HotelType> | |
| HREQ | 0 - 1 | <HotelExtras> | |
| HACQ | 0 - 1 | <HotelChildren> |
|
<HtlIndexPropList> |
|
|
Ordering |
KLR |
Min/Max |
XML Tag |
| CTRL | 1 – 1 | <Control> | |
| HIRT | 1 – 1 | <HtlIndexRate> | |
| HTGC | 1 – 1 | <HotelPropertyGeocode> | |
| HTPR | 1 – 45 | <HotelPropertyRecord> |
|
<HotelSimilarNames> |
|
|
Ordering |
KLR |
Min/Max |
XML Tag |
| 6181 | 1 – 1 | <HotelSimilarNames> |
See the following topics for additional information for hotel processing.