HotelIndex_8_1_1 Documentation

<HotelIndex_8_1_1> HTL05HOIFNC

+ Responses

+ <HeadLineAd>

5501 5.0

<Type>

Alpha

Description of Field:
Type Response Returned
Format (a-alpha):
a
Special Format:
N/A
Possible Values (List):
A=Ads returned
N=No ADS were found (Ad Items = 0)
E=Error occurred, number of ad Items will be 0 and only an Error Message exists below
How is null data specified?
N/A
What does null data indicate?
N/A

<EndPt>

Alpha

Description of Field:
Destination Airport/City code
Format (a-alpha)
aaaaa
Special Format:
Left justified, blank filled.
How is null data specified?
N/A
What does null data indicate?
No data should result in error
If variable length, specify the maximum allowable length.
N/A

Alpha

Description of Field:
Origin Airport/City code
Format (a-alpha):
aaaaa
Special Format:
Left justified, blank filled.
How is null data specified?
N/A
What does null data indicate?
No data should result in error
If variable length, specify the maximum allowable length.
N/A

AdItemsCnt
Structured data only.
Not in XML.

Numeric

Description of Field:
The number of ad items returned in this block
Format (n-numeric):
nn
Special Format:
Right justified, zero filled
Examples:
02=2 ads returned
How is null data specified?
00
What does null data indicate?
No ads returned
If variable length, specify the maximum allowable length.
N/A

Numeric

Description of Field:
The total number of ad items combined from all 5501 blocks returned in this response
Format (n-numeric):
nnnn
Special Format:
Right justified, zero filled
Examples:
0002=2 ads returned
How is null data specified?
0000
What does null data indicate?
No ads returned
If variable length, specify the maximum allowable length.
N/A

+ <TypeAQual>

[Qualified By: Type of A]

FieldSet

n/a

+ <AdItemAry>

Array

n/a

+ <AdItem>

FieldSet

n/a

<Vnd>

Alphanumeric

Description of Field:
First part of key to ad. Previously contained ad number, currently does not have specific meaning other than to partially identify ad. All three fields (Vendor Code, Ad Number, and Vendor Type) must be sent in a 5510v5, Headlines Ads Text Request, exactly as received to request backup explanatory text.
Format (x-alpha/numeric):
xxx
Special Format:
N/A
Examples:
Any combination of alpha/numeric characters.
How is null data specified?
No data results in error
What does null data indicate?
No data results in error
If variable length, specify the maximum allowable length.
N/A

<Num>

Alphanumeric

Description of Field:
Second part of key to ad. Previously contained ad number, currently does not have specific meaning other than to partially identify ad. All three fields (Vendor Code, Ad Number, and Vendor Type) must be sent in a 5510v5, Headlines Ads Text Request, exactly as received to request backup explanatory text.
Format (x-alpha/numeric):
xxxx
Special Format:
N/A
Examples:
Any combination of alpha/numeric characters.
How is null data specified?
No data results in error
What does null data indicate?
No data results in error
If variable length, specify the maximum allowable length.
N/A

<VType>

Alphanumeric

Description of Field:
Third part of key to ad for which backup text was requested. Previously contained vendor type, currently does not have specific meaning other than to partially identify ad. All three fields (Vendor Code, Ad Number, and Vendor Type) must be sent in a 5510v5, Headlines Ads Text Request, exactly as received to request backup explanatory text.
Format (x-alpha/numeric):
x
Special Format:
N/A
Examples:
Any combination of alpha/numeric characters.
How is null data specified?
No data results in error
What does null data indicate?
No data results in error
If variable length, specify the maximum allowable length.
N/A

Alphanumeric

Description of Field:
First point of sale parameter used to select this ad
Format (x-alphanumeric):
x
Special Format:
Will always be blank, no longer supported.
Possible Values:
Character blank
How is null data specified?
Character blank
What does null data indicate?
OK

Alphanumeric

Description of Field:
Second point of sale parameter used to select this ad
Format (x - alphanumeric):
x
Special Format:
Will always be blank, no longer supported.
Possible Values:
Character blank
How is null data specified?
Character blank
What does null data indicate?
OK

Alpha

Description of Field:
Indicates whether backup text is available
Format (a-alpha):
a
Special Format:
N/A.
Possible Values:
Y=Text exists for this ad
N=No text exists for this ad
How is null data specified?
Character blank
What does null data indicate?
No data should be treated as "N"

<Ad>

Alphanumeric

Description of Field:
Headline message
Format (x-alpha/numeric):
x
Special Format:
N/A
Examples:
Any alpha numeric data
How is null data specified?
Character blanks
What does null data indicate?
Character blanks should be output same as other data
If variable length, specify the maximum allowable length.
N/A

+ <TypeEQual>

[Qualified By: Type of E]

FieldSet

n/a

<Msg>

Character

Description of Field:
Error Message
Format (x-alpha/numeric):
x
Special Format:
N/A
Examples:
N/A
How is null data specified?
Character blanks
What does null data indicate?
Character blanks should be output same as other data
If variable length, specify the maximum allowable length.
N/A

<Num>

Character

Description of Field:
Error Number
Format (x-alpha/numeric):
xxxx
Special Format:
N/A
Examples:
N/A
How is null data specified?
Character blanks
What does null data indicate?
Character blanks should be output same as other data
If variable length, specify the maximum allowable length.
N/A

+ <HotelIndex>

6116 8.1

+ <RankingValues>

CDRK 1.0

+ <CorpRankValAry>

Array

n/a

+ <CorpRankValInfo>

FieldSet

n/a

Alphanumeric

Corporate Ranking as determined by The Data Store

Alpha

Whether Corporate Preferences exist for this item (air and car) or Whether Rank is for Property or Chain (hotel)
Indicators: Y - Preferred
X - Excluded
P - Property Rank
C - Chain Rank
Blank - no preference
Data will contain either a Y or X
OR a P or C OR Blank

Alphanumeric

Office Ranking as determined by The Data Store

Alpha

Whether Office Preferences exist for this item (air and car) or Whether Rank is for Property or Chain (hotel)
Indicators: Y - Preferred
X - Excluded
P - Property Rank
C - Chain Rank
Blank - no preference
Data will contain either a Y or X
OR a P or C OR Blank

Alphanumeric

Traveler Ranking as determined by The Data Store

Alpha

+ <Control>

CTRL 1.0

Numeric

Number of KLRs following this KLR in the Data Record. Range 0 - 99999

+ <KlrAry>

Array

n/a

+ <Klr>

FieldSet

n/a

<ID>

Alphanumeric

Record Identifier of a KLR which occurs one or more times in this Data Record

Numeric

Number of times the KLR occurs in this Data Record. Range 1 - 9999

+ <ErrText>

EROR 1.0

NOTE: When this KLR is returned it will be the only KLR present in the response.
<Err>	Alphanumeric	8	Field Description: Error code provided for the client. Format (x-alpha/ numeric): xxxxxxxx Special Format: All EROR KLRs contain an 8-byte error code field. In the interest of standardization and to ensure each error code is unique, applications must adhere to the following error code numbering system: Byte 1: Alphanumeric Id of the application area owning this error code Byte 2: Severity number of error. Blank and zero indicates no priority exists. Severity 9 is Catastrophic/Highest Severity. Bytes 3-8: Numeric in the range 000000 - 999999 identifying the error situation Possible Values(List): A = Availability B = PNR / Booking File C = Cars D = Document Production F = Fares H = Headlines I = Infrastructure (SDD) J = Leisure L = Links M = Seating P = Client File Q = Queues R = Hotels S = Sell T = Travelscreen V = Terminal Security W = Rail Example: Err = "A 000510" Err = "D 000000' "A" = Availability "D" = Document Production " " = Character blank "000105" = Error number for "NO DISPLAYABLE FLIGHTS" How is null data specified? N/A What does null data indicate? No data results in error.

Alphanumeric

Field Description:
ID of the KLR that caused this error.
Format (x-alpha/numeric):
xxxx
Special Format:
N/A
Examples:
DP01
AAGA
0000
How is null data specified?
N/A
What does null data indicates?
No data results in error.

+ <InsertedTextAry>

Array

n/a

+ <InsertedText>

FieldSet

n/a

Numeric

Field Description:
Location of start of inserted text in Error Text field
Format (n-numeric):
nnn
Special Format:
N/A
Examples:
000
How is null data specified?
N/A
What does null data indicates?
No data results in error

<Len>

Numeric

Field Description:
Length of inserted text
Format (n-numeric):
nn
Special Format:
N/A
Examples:
00
How is null data specified?
N/A
What does null data indicate?
No data results in error

<Text>

Alphanumeric

To End

Field Description:
Complete error message, including any inserted text items
Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxxx
Special Format:
N/A

Examples:
ERROR 4366 - FORM OF PAYMENT REQUIRED

How is null data specified?
N/A
What does null data indicates?
No data results in error.

+ <HtlIndexRate>

HIRT 1.0

Alpha

Currency stored on Roommaster

Numeric

The number of places to the right of the implied decimal for the stored currency

Numeric

The lowest RAC rate amount in the currency stored in MVS

Alpha

Currency specified by desired currency or EUR.

Numeric

The number of places to the right of the implied decimal for the alternate currency rate.

Numeric

The lowest RAC rate amount in the desired currency (or EUR if HMCT bit is on)

+ <HotelChainBrochure>

HTCB 1.0

Alphanumeric

+ <HotelChainSearchStatus>

HTCS 1.0

+ <ChainSearchStatusAry>

Array

n/a

Numeric

0=Successful
1=Invalid chain code
2=No properties found for this chain in city
3=No properties available for specified dates
4=Not Selected
5=Selected
6=Not selected, no multi-level rates

+ <HotelError>

HTER 1.0

<Msg>

Character

<Num>

Character

+ <HotelPropertyGeocode>

HTGC 1.0

Data for the Property Latitude and Longitude is NOT currently available via external structured data or XML.
<LatSign>	Character	1	Blank = North of Equator -= South of Equator

<Lat>

Numeric

3V4. Example: 0843675 implies 3 digits to the left and 4 digits to the right of the implied decimal point (implied as 084.3675)

Character

Blank =East of Meridian
-= West

<Lon>

Numeric

3V4. Example: 1032419 implies 3 digits to the left and 4 digits to the right of the implied decimal point
(implied as 103.2419)

+ <HotelGetMore>

HTGM 1.0

Numeric

Data Base Key for start of property chain.
Set this field to the value returned in the previous HOI/HOA transaction's response.

Numeric

Data Base Key for end of property chain.
Set this field to the value returned in the previous HOI/HOA transaction's response.

Numeric

Data Base Key for current position of property chain.
Set this field to the value returned in the previous HOI/HOA transaction's response.

Character

Optional search criteria status, identifies whether the corresponding entry in the Criteria Slot Array was relaxed in qualifying the properties returned. The sequence is priority order.
Sets this field to the value returned in the previous HOI/HOA transaction's response.

Numeric

Total number of properties retrieved so far, cumulative. Must set this field to the value returned in the previous transaction's response.

Numeric

MVS subtotal umber of properties. Must set this field to
The value returned in the previous transaction's response.
Will be zeroes for HOA

Alpha

Y = Yes
N = No and is the default.
The HTGM should only be sent as a request when the more indicator is set to Y.

+ <HotelPropHeader>

HTPH 1.0

<City>

Alpha

Three-character city code for the city being searched, blank filled, left justified

Alpha

If not blank, identifies the reference point used in the search. Otherwise, the corresponding airport was used. Only applies to standard (non-property specific) HOA request. Can also contain the Postal Code that was used in a Postal Code search. See Reference Point /Postal Code Indicator below.
Note: Postal Code is not applicable to a response category of "T" (TravelScreen)

Character

If the Reference Point/Postal Code field is not blank, used to determine the type of data in the field.
P= Data in Reference Point/Postal Code field is a Postal Code
R= Data in Reference Point/Postal Code field is a Reference Point

<State>

Alpha

State code for the city being searched

Alpha

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

Character

Y= City code and reference name match
N= No match. A warning should be given to the user. For example, customer asked for "MILE HIGH STADIUM" in FLL.

+ <HotelPropertyListCount>

HTPL 1.0

This detail block will occurr when there is a successful return from the request, if the Type Response Returned field = P in the HTTR KLR
<TotCnt>	Numeric	4	The total number of Property items that will be returned in this transaction. This is how many properties the agent can see before a Get More is necessary. HOA can return 14 properties, and HOI can return 45 properties.

+ <HotelPropertyRecord>

HTPR 1.0

<Vnd>

Alpha

Property's chain code, 2 characters followed by a blank

<RMID>

Numeric

Property's RoomMaster Number

Alphanumeric

Short name of property

Alphanumeric

Property's short address

<Dist>

Numeric

The distance from the city center or reference point identified in the request to the property

<Dir>

Alpha

The direction (N, S, E, W, NW, etc.) from city center or reference point to the property

<Locn>

Alpha

The primary location:
C= City A= Airport
R= Resort S= Suburban
Left justified

Alpha

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

Character

L= Link partner
I= Inside Availability Link
R =RoomMaster only participant
B = Best Available Rate participant

Character

AAA Rating. Will be blank if no rating exists, or a value from 1 to 5.

Character

Y= Spectrum advertiser / Featured Property
N= Not an advertiser

+ <HotelPropertyStatus>

HTPS 1.0

+ <PropStatusAry>

Array

n/a

Numeric

Used in the case of property-specific results.
Repeats once for each property requested, in the order requested.

Standard HOA = Should be ignored

Property Specific HOA - Identifies the search status for each of the properties identified in the RoomMaster Property Number array of the HOA request
0=Successful, corresponding property in the array found
1=Invalid property number in the corresponding entry of the RoomMaster Property Number array
2=Property not available for the dates specified
3=City/Airport/Reference Point specified in City Code is not valid for property

Travel Screen HOA with preferred properties
0=Property unmatched on qualifiers
1=Invalid property number
2=Property not available
3=City code not matched to property
4=Non Apollo property
5=Property selected by Travel Screen
6=Property found, rate code not available (no property information or rates returned)

Data Store (Filtered) HOA with preferred properties
0=Property unmatched on qualifiers
1=Invalid property numbers
2=Property sold out
3=City code not matched to property
4=Non Apollo property
5=Property selected
6=Not used
7=Property found, rate access code not found or not available (will return property with or without rates)

+ <HotelSimilarNames>

HTSN 1.0

Alpha

<City>

Alpha

<State>

Alpha

+ <HtlTravelscreenData>

HTTD 1.0

Alpha

"B" = Business level preferences returned
"P" = Personal level preferences returned
"M" = Merged preferences returned

<City>

Alpha

City code

Alpha

Not used (blank)

+ <HtlGeneralPreferences>

HTTG 1.0

+ <VndAry>

Array

n/a

+ <VndInfo>

FieldSet

n/a

<Vnd>

Character

Alphanumeric

<Rate>

Alphanumeric

+ <HtlPreferences>

HTTP 1.0

+ <PropDataAry>

Array

n/a

+ <PropData>

FieldSet

n/a

<Num>

Numeric

<Type>

Alphanumeric

<Rate>

Alphanumeric

+ <HotelType>

HTTR 1.0

Alphanumeric

Type Of Response Returned

List of Possible Values:
P = Property List returned

S = Similar Name List returned

E = Error message returned

H = Hotel Travelscreen response

R = RoomMaster Response to an HOC Request

I = Inside Availability Response to an HOC Request

A = Alternate Availability Response to an HOC Request

0 = Link sell successful.

F = Link sell failed.

Required/Optional: Required

+ <HtlIndexPropList>

6117 8.0

+ <Control>

CTRL 1.0

Numeric

Number of KLRs following this KLR in the Data Record. Range 0 - 99999

+ <KlrAry>

Array

n/a

+ <Klr>

FieldSet

n/a

<ID>

Alphanumeric

Record Identifier of a KLR which occurs one or more times in this Data Record

Numeric

Number of times the KLR occurs in this Data Record. Range 1 - 9999

+ <HtlIndexRate>

HIRT 1.0

Alpha

Currency stored on Roommaster

Numeric

The number of places to the right of the implied decimal for the stored currency

Numeric

The lowest RAC rate amount in the currency stored in MVS

Alpha

Currency specified by desired currency or EUR.

Numeric

The number of places to the right of the implied decimal for the alternate currency rate.

Numeric

The lowest RAC rate amount in the desired currency (or EUR if HMCT bit is on)

+ <HotelPropertyGeocode>

HTGC 1.0

Data for the Property Latitude and Longitude is NOT currently available via external structured data or XML.
<LatSign>	Character	1	Blank = North of Equator -= South of Equator

<Lat>

Numeric

3V4. Example: 0843675 implies 3 digits to the left and 4 digits to the right of the implied decimal point (implied as 084.3675)

Character

Blank =East of Meridian
-= West

<Lon>

Numeric

3V4. Example: 1032419 implies 3 digits to the left and 4 digits to the right of the implied decimal point
(implied as 103.2419)

+ <HotelPropertyListCount>

HTPL 1.0

This detail block will occurr when there is a successful return from the request, if the Type Response Returned field = P in the HTTR KLR
<TotCnt>	Numeric	4	The total number of Property items that will be returned in this transaction. This is how many properties the agent can see before a Get More is necessary. HOA can return 14 properties, and HOI can return 45 properties.

+ <HotelPropertyRecord>

HTPR 1.0

<Vnd>

Alpha

Property's chain code, 2 characters followed by a blank

<RMID>

Numeric

Property's RoomMaster Number

Alphanumeric

Short name of property

Alphanumeric

Property's short address

<Dist>

Numeric

The distance from the city center or reference point identified in the request to the property

<Dir>

Alpha

The direction (N, S, E, W, NW, etc.) from city center or reference point to the property

<Locn>

Alpha

The primary location:
C= City A= Airport
R= Resort S= Suburban
Left justified

Alpha

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

Character

L= Link partner
I= Inside Availability Link
R =RoomMaster only participant
B = Best Available Rate participant

Character

AAA Rating. Will be blank if no rating exists, or a value from 1 to 5.

Character

Y= Spectrum advertiser / Featured Property
N= Not an advertiser

+ <HotelSimilarNames>

6181 8.0

6181 - Car/Hotel - Similar Names List Version: 05.00 This detail block will be repeated one or more times when there is a successful return from the availability re quest and the Type Response Returned field= S. The block will be preceded by the header of the transaction that invoked it. It is transaction type 6181. Start Definition of Block
RecCnt Structured data only. Not in XML.	Numeric	2	The number of detail similar name entries returned in this block. A maximum of 28 is allowed in each similar names block.

Numeric

The total number of items that will be returned from all 6181 blocks

+ <SmlrNameAry>

Array

n/a

+ <SmlrName>

FieldSet

n/a

Alpha

<City>

Alpha

<State>

Alpha