HotelDescription_6 Documentation

<HotelDescription_6> HTL03HODFNC

+ Responses

+ <HotelDescHeader>

6121 6.0

+ <FreeFormAddr>

HDAD 1.0

+ <AddressAry>

Array

n/a

Character

255

Repeats from one to 5 times.
These lines will contain free form address details.

+ <ChainBrochure>

HDCB 1.0

Numeric

Description of Field:
Length of each line in the paragraph text.
For text Content aligned with the 'Green Screen' this value would be '064' to flag the last display column character of each row of text - otherwise, this value will be '000' where the row length for text can vary.
Format (a-alpha, n-numeric, x-alpha/numeric):
nnn
How is null data specified?
Character zeroes
What does null data indicate?
NA
If variable length, specify the maximum allowable length.
NA

Character

255

Description of Field:
This field may contain a corporate slogan, a marketing message, an announcement of a special rate or an announcement of a new property.

Format (a-alpha, n-numeric, x-alpha/numeric, c - character):
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Special Format:
Left justified, blank filled
How is null data specified?
N/A
What does null data indicate?
N/A

+ <FormattedAddr>

HDFD 1.0

Numeric

Description of Field:
Property telex number
Format (a-alpha, n-numeric, x-alpha/numeric):
nnnnnnnnnn
How is null data specified?
Character blanks
What does null data indicate?
No number specified
If variable length, specify the maximum allowable length.
N/A

<StNum>

Alphanumeric

Description of Field:
number on street and or Name.
Format (a-alpha, n-numeric, x-alpha/numeric):
xxxxxxxxxxxxxx
How is null data specified?
Character blanks
What does null data indicate?
No street number or name exists
If variable length, specify the maximum allowable length.
N/A

Alpha

Description of Field:
Street direction of an address (e.g., N, E, S, NW, SW)
Format (a-alpha, n-numeric, x-alpha/numeric):
aaaaaaaaaaaaaaaaa
How is null data specified?
Character blanks
What does null data indicate?
No direction specified
If variable length, specify the maximum allowable length.
N/A

Alpha

Description of Field:
Usually a letter right after the street number (A in 66-A, B in 123-B etc)
Format (a-alpha, n-numeric, x-alpha/numeric):
aaaaaaaaaaaaaaaaa
How is null data specified?
Character blanks
What does null data indicate?
No suffix specified
If variable length, specify the maximum allowable length.
N/A

Numeric

Description of Field:
Numerical equivalent of a rural township as defined within a given area (e.g., 12, 99).
Format (a-alpha, n-numeric, x-alpha/numeric):
nnnnnnnnnnnnnn
How is null data specified?
Character blanks
What does null data indicate?
No number specified
If variable length, specify the maximum allowable length.
N/A

<POBox>

Alphanumeric

Description of Field:
Defines a Post Office Box number.
Format (a-alpha, n-numeric, x-alpha/numeric):
xxxxxxxxxxxxxxx
How is null data specified?
Blanks
What does null data indicate?
No number specified
If variable length, specify the maximum allowable length.
N/A

Alphanumeric

Description of Field:
Building name, room, apartment, or suite number
Format (a-alpha, n-numeric, x-alpha/numeric):
xxxxxxxxxxxxxxxx
How is null data specified?
Character blanks
What does null data indicate?
No data specified
If variable length, specify the maximum allowable length.
N/A

<City>

Alphanumeric

Description of Field:
City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).
Format (a-alpha, n-numeric, x-alpha/numeric):
xxxxxxxxxxxxxxx
How is null data specified?
Character blanks
What does null data indicate?
No data specified
If variable length, specify the maximum allowable length.
N/A

Alphanumeric

Description of Field:
Post Office Code number.
Format (a-alpha, n-numeric, x-alpha/numeric):
xxxxxxxxxxxxxxx
How is null data specified?
Character blanks
What does null data indicate?
No data specified
If variable length, specify the maximum allowable length.
N/A

Alphanumeric

Description of Field:
County or Region Name (e.g., Fairfax).
Format (a-alpha, n-numeric, x-alpha/numeric):
xxxxxxxxxxxxxxx
How is null data specified?
Character blanks
What does null data indicate?
No data specified
If variable length, specify the maximum allowable length.
N/A

Alpha

Description of Field:
Country name (e.g., Ireland).
Format (a-alpha, n-numeric, x-alpha/numeric):
aaaaaaaaaaaaaaa
How is null data specified?
Character blanks
What does null data indicate?
No data specified
If variable length, specify the maximum allowable length.
N/A

Alpha

Description of Field:
ISO 3166 code for a country
Format (a-alpha, n-numeric, x-alpha/numeric):
aa
How is null data specified?
Character blanks
What does null data indicate?
No data specified
If variable length, specify the maximum allowable length.
N/A

+ <GetMoreOpt>

HDGM 1.0

Alpha

Description of Field:
Keyword code - This will be the first keyword code of the set of 3 keywords for which get more is requested.
Its length is 30 as same is required by 1P.
Format (a-alpha, n-numeric, x-alpha/numeric):
Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
Special Format:
NA
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

Alpha

Description of Field:
Keyword code - This will be the second keyword code of the set of 3 keywords for which get more is requested.
Its length is 30 as same is required by 1P.
Format (a-alpha, n-numeric, x-alpha/numeric):
Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
Special Format:
NA
How is null data specified?
ZERO
What does null data indicate?
Less than two keywords requested for this Get More
If variable length, specify the maximum allowable length.
N/A

Alpha

Description of Field:
Keyword code - This will be the third keyword code of the set of 3 keywords for which get more is requested.
Its length is 30 as same is required by 1P.
Format (a-alpha, n-numeric, x-alpha/numeric):
Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
Special Format:
NA
How is null data specified?
ZERO
What does null data indicate?
Less than two keywords requested for this Get More
If variable length, specify the maximum allowable length.
N/A

Character

To End

Description of Field:
Get More token blob
Format (a-alpha, n-numeric, x-alpha/numeric):
xxxxxxxxxx....
Special Format:
NA
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.
(Max length of KLR (4000) - Fixed length of KLR)

+ <HeaderDesc>

HDHD 1.0

<Chain>

Alpha

Description of Field:
Vendor chain code associated with the text that follows.
Format (a-alpha, n-numeric, x-alpha/numeric):
AAA
Special Format:
This field will be blank for a "get more" request, is 2-character, left justified, and blank filled.
How is null data specified?
blanks
What does null data indicate?
Get more processing
If variable length, specify the maximum allowable length.
N/A

Alphanumeric

Description of Field:
RoomMaster ID associated with the text that follows.
It would be left justified and right padded with blanks. For numeric property like 12, it should appear as '00012bb'. For alpha-numeric, it is assumed that it will always be 5 bytes long so not left padding of 0 is required.
Please note that length is 7 to support 1P properties as well.
Format (a-alpha, n-numeric, x-alpha/numeric):
xxxxx
Special Format:
It will be zero for chain requests. This field will have zeroes for a "get more" request.
How is null data specified?
zeroes
What does null data indicate?
Chain or get more processing
If variable length, specify the maximum allowable length.
N/A

<Name>

Alpha

Description of Field:
Full name of the property or vendor chain
Format (a-alpha, n-numeric, x-alpha/numeric):
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
Special Format:
For a chain request, it is the chain name. It will be blank for "More" requests
How is null data specified?
Blanks
What does null data indicate?
Get more processing
If variable length, specify the maximum allowable length.
N/A

Numeric

Description of Field:
The total number of menu items returned in this response in HDKL KLR. It depends on the value of the Type Response Returned field.
Format (a-alpha, n-numeric, x-alpha/numeric):
nnnn
How is null data specified?
N/A
What does null data indicate?
N/A
If variable length, specify the maximum allowable length.
N/A

<Desc>

Alpha

Description of Field:
The Descriptive Info in 'HDKD' and/or 'HDLI' KLR returned in this response. This depends on the value of the Type Response Returned field.
Format (a-alpha, n-numeric, x-alpha/numeric):
alpha
Special Format:
This field will be 'Y' or 'N'
How is null data specified?
Blank
What does null data indicate?
Default to 'N'
If variable length, specify the maximum allowable length.
N/A

+ <KeywordDesc>

HDKD 1.0

Numeric

Description of Field:
Sequence no.
Format (a-alpha, n-numeric, x-alpha/numeric):
nnn
Special Format:
NA
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

Alpha

Description of Field:
Description code
Format (a-alpha, n-numeric, x-alpha/numeric):
Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
Special Format:
NA
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

Alpha

Description of Field:
Keyword description returned for type 'K'
Format (a-alpha, n-numeric, x-alpha/numeric):
Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
Special Format:
Free-form text
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

Numeric

Description of Field:
Length of each text item in text field.
For text Content aligned with the 'Green Screen' this value would be '064' to flag the last display column character of each row of text - otherwise, this value will be '000' where the row length for text can vary.
Format (a-alpha, n-numeric, x-alpha/numeric):
nnn
How is null data specified?
Character zeroes
What does null data indicate?
Length of each text item is equal to length of text in text field
If variable length, specify the maximum allowable length.
NA

<Spare>

Alphanumeric

100

Description of Field:
Spares for future expansion
Format (a-alpha, n-numeric, x-alpha/numeric):
NA
How is null data specified?
NA
What does null data indicate?
NA
If variable length, specify the maximum allowable length.
NA

Character

To End

Description of Field:
Free form keyword text
Format (a-alpha, n-numeric, x-alpha/numeric):
Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa...
How is null data specified?
Character blanks
What does null data indicate?
No keyword text available

+ <KeywordList>

HDKL 1.0

+ <KeywordsAry>

Array

n/a

+ <Keywords>

FieldSet

n/a

Numeric

Description of Field:
The menu number for this item
Format (a-alpha, n-numeric, x-alpha/numeric):
nnn
How is null data specified?
N/A
What does null data indicate?
N/A
If variable length, specify the maximum allowable length.
N/A

Alpha

Description of Field:
The character mnemonic used for the associated keyword
Format (a-alpha, n-numeric, x-alpha/numeric):
aaaa
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

Alpha

Description of Field:
A descriptive label for the keyword
Format (a-alpha, n-numeric, x-alpha/numeric):
Aaaaaaaaaaaaaaaaaaaaa
How is null data specified?
Character blanks
What does null data indicate?
No property description exists
If variable length, specify the maximum allowable length.
N/A

+ <KeywordListItems>

HDLI 1.0

Numeric

Description of Field:
Sequence no
Format (a-alpha, n-numeric, x-alpha/numeric):
nnn
Special Format:
NA
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

Alpha

Alpha

<Spare>

Alphanumeric

100

+ <DescLenAry>

Array

n/a

+ <DescLenInfo>

FieldSet

n/a

DescLen
Structured data only.
Not in XML.

Numeric

Description of Field:
Length of text in below item info field
Format (a-alpha, n-numeric, x-alpha/numeric):
nnn
How is null data specified?
Character zeroes
What does null data indicate?
No text in below item info field
If variable length, specify the maximum allowable length.
NA

Character

Description of Field:
Free form keyword text.
Format (a-alpha, n-numeric, x-alpha/numeric):
Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
How is null data specified?
Character blanks
What does null data indicate?
No keyword text available
If variable length, specify the maximum allowable length.
999

+ <PropertyGResp>

HDPG 1.0

Alpha

Description of Field:
Phone number of the property, left justified and blank filled
Format (a-alpha, n-numeric, x-alpha/numeric):
aaaaaaaaaaaaaaaaa
How is null data specified?
Character blanks
What does null data indicate?
No phone number exists
If variable length, specify the maximum allowable length.
N/A

<PFAX>

Alpha

Description of Field:
FAX number of the property, left justified and blank filled
Format (a-alpha, n-numeric, x-alpha/numeric):
aaaaaaaaaaaaaaaaa
How is null data specified?
Character blanks
What does null data indicate?
No fax number exists
If variable length, specify the maximum allowable length.
N/A

Alphanumeric

Description of Field:
Blank or 1 to 5. Auto Club diamond rating
Format (a-alpha, n-numeric, x-alpha/numeric):
X
How is null data specified?
Character blank
What does null data indicate?
No AAA rating exists or requestor is not allowed to receive AAA ratings
If variable length, specify the maximum allowable length.
N/A

Alphanumeric

Description of Field:
Property check in time, right justified
Format (a-alpha, n-numeric, x-alpha/numeric):
XXXX
Special Format:
NNAA
Examples:
Where NN = numeric value for hour of day
Where AA = AM for morning
PM for evening
N for Noon
M for Midnight
For e.g -' 3PM ','12N '
How is null data specified?
Character blanks
What does null data indicate?
Property has not specified a check in time
If variable length, specify the maximum allowable length.
N/A

<EndTm>

Alphanumeric

Description of Field:
Property check out time
Format (a-alpha, n-numeric, x-alpha/numeric):
XXXX
Special Format:
NNAA
Examples:
Where NN = numeric value for hour of day
Where AA = AM for morning
PM for evening
N for Noon
M for Midnight
For e.g -' 3PM ','12N 'How is null data specified?
Character blanks
What does null data indicate?
Property has not specified a check in time
If variable length, specify the maximum allowable length.
N/A

Alpha

Description of Field:
Code for the nearest airport, left justified and blank filled
Format (a-alpha, n-numeric, x-alpha/numeric):
XXXXX
Special Format:
Currently codes are all alpha
How is null data specified?
Character blanks
What does null data indicate?
Property has not been connected to an airport
If variable length, specify the maximum allowable length.
N/A

Numeric

Description of Field:
The distance from the airport to the property, right justified zero filled
Format (a-alpha, n-numeric, x-alpha/numeric):
nnn
How is null data specified?
Character blanks
What does null data indicate?
No distance could be determined
If variable length, specify the maximum allowable length.
N/A

Alpha

Description of Field:
The direction from the airport to the property
Format (a-alpha, n-numeric, x-alpha/numeric):
XX
Possible Values (List or Range):
N, NE, E, SE, SW, NE, NW, S, W
How is null data specified?
Character blanks
What does null data indicate?
No value in database

Alpha

Description of Field:
Unit of measure for distance
Format (a-alpha, n-numeric, x-alpha/numeric):\
X
Possible Values (List or Range):
M=Miles
K=Kilometers
How is null data specified?
Character blank
What does null data indicate?
No value in database

Alpha

Description of Field:
Country code
Format (a-alpha, n-numeric, x-alpha/numeric):\
AAA
Possible Values (List or Range):
'GA'
How is null data specified?
Character blank
What does null data indicate?
No value in database

<State>

Alpha

Description of Field:
State code
Format (a-alpha, n-numeric, x-alpha/numeric):\
AAA
Possible Values (List or Range):
'GA'
How is null data specified?
Character blank
What does null data indicate?
No value in database

<City>

Alpha

Description of Field:
City code
Format (a-alpha, n-numeric, x-alpha/numeric):\
AAAAA
Possible Values (List or Range):
'DEN '
How is null data specified?
Character blank
What does null data indicate?
No value in database

Alpha

Description of Field:
Free Transportation indicator
Format (a-alpha, n-numeric, x-alpha/numeric):\
A
Possible Values (List or Range):
'Y' or 'N'
How is null data specified?
Default as 'N'
What does null data indicate?
'N'

Alphanumeric

Description of Field:
Postal code of property number
Format (a-alpha, n-numeric, x-alpha/numeric):\
AN
Possible Values (List or Range):
'30084'
How is null data specified?
Blanks
What does null data indicate?
No data in database

Numeric

Description of Field:
Tax rate
Format (a-alpha, n-numeric, x-alpha/numeric):
nn.nn
Possible Values (List or Range):
'11.62'
How is null data specified?
Character zeroes
What does null data indicate?
No data in database

Alpha

Description of Field:
Family plan supported by property
Format (a-alpha, n-numeric, x-alpha/numeric):
A
Possible Values (List or Range):
'Y' or 'N'
How is null data specified?
'N'
What does null data indicate?
'N'

Numeric

Description of Field:
Commission percentage
Format (a-alpha, n-numeric, x-alpha/numeric):
nn.nn
How is null data specified?
Character zeroes
What does null data indicate?
No data in database

Alpha

Description of Field:
Currency code
Format (a-alpha, n-numeric, x-alpha/numeric):
aaa
Possible Values (List or Range):
'USD'
How is null data specified?
Blanks
What does null data indicate?
No data in database

Alpha

Description of Field:
Fire safety certified indicator
Format (a-alpha, n-numeric, x-alpha/numeric):
a
Possible Values (List or Range):
'Y' or 'N'
How is null data specified?
'N'
What does null data indicate?
'N'

Numeric

Description of Field:
Currency code
Format (a-alpha, n-numeric, x-alpha/numeric):
Nnnn (may be right padded with blanks)
Possible Values (List or Range):
'145 '
How is null data specified?
Blanks
What does null data indicate?
No data in database

Numeric

Description of Field:
Reservation phone number
Format (a-alpha, n-numeric, x-alpha/numeric):
nnn-nnn-nnnn (Right padded with blanks)
Possible Values (List or Range):
'800-654-2000 '
How is null data specified?
Blanks
What does null data indicate?
No data in database

+ <MealPlanAry>

Array

n/a

Character

Repeats from zero to 8 times.

+ <RespType>

HDTR 1.0

Alphanumeric

Description of Field:
Format (a-alpha, n-numeric, x-alpha/numeric):
X
Special Format:
Possible Values (List or Range):
P=Property keywords returned. Full response consists of header, property keyword records (HDKD/HDLI - depending on the keyword returned), and optionally menu records (HDKL).
C=Chain keywords returned. Full response consists of header, chain keyword records (HDKD/HDLI - depending on the keyword returned), and optionally menu records (HDKL).
R=Chain generic data returned. Full response consists of header, HOD chain generic record, and optional menu records (HDKL).
G=Property generic data returned. Full response consists of header, HOD property generic record and optional records (HDKL).
E=Error message returned. Full response consists of error message (HTER).
S= Alternate reply (Similar name list)
L=Alternate reply (Hotel index reply)
How is null data specified?
N/A
What does null data indicate?
N/A

+ <HotelError>

HTER 2.0

+ <ErrMsgAry>

Array

n/a

Start Definition of Hotel Error Response KLR
Start of Error Message Section

+ <ErrMsg>

FieldSet

n/a

<Msg>

Character

Description of Field:
This is a text error message.
Format (a-alpha, n-numeric, x-alpha/numeric):
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Special Format:
Left justified, blank filled
Examples:
Invalid credit card address
Access restricted
How is null data specified?
This field can be blanks.
What does null data indicate?
No error message is available.

<Num>

Character

Description of Field:
This is a number that indicates the type of error taken.
Format (a-alpha, n-numeric, x-alpha/numeric):
nnnn
Special Format:
Right justified, zero filled
Examples:
0404
0133
How is null data specified?
This field can be zeroes or blanks. This field can not be null if there is no text in the previous field
What does null data indicate?
There is not error number that corresponds to the error text.

Character

F= Fatal error, processing halted
W= Warning , processing continued