HotelAvailability_8_0 Documentation

<HotelAvailability_8_0> HTL05HOAFNC

+ Responses

+ <TravelScreenAvailHdr>

4911 5.0

4911 - Travelscreen Availability Response - Header Output - Version 5.00 Start Definition of Basic Response
<Type>	Alpha	1	C = from Car Availability H = from Hotel Availability E = error response returned

+ <TypeErrQual>

[Qualified By: Type of E]

FieldSet

n/a

<Msg>

Character

error text returned

<Num>

Character

error number

+ <TypeCarQual>

[Qualified By: Type of C]

FieldSet

n/a

Alpha

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

Alpha

Alpha

N = Preferences - No match found.

CityVCnt
Structured data only.
Not in XML.

Numeric

The number of vendors returned in the city preferences.

GenVCnt
Structured data only.
Not in XML.

Numeric

The number of vendors returned in the General
preferences.

+ <CarVAry1>

Array

n/a

+ <VCode>

FieldSet

n/a

<Vnd>

Character

Alpha

Alpha

Character

Numeric

Character

<Rate>

Alphanumeric

+ <CarVAry2>

Array

n/a

+ <VCode>

FieldSet

n/a

<Vnd>

Character

Character

Character

Character

Character

<Rate>

Alphanumeric

+ <TypeHtlQual>

[Qualified By: Type of H]

FieldSet

n/a

Alpha

B = Business level preferences returned.
P = Personal level preferences returned
M = Merged Preferences returned

Alpha

Alpha

Currently not used (blank)

CityVCnt
Structured data only.
Not in XML.

Numeric

The number of vendors returned in the city preferences.

GenVCnt
Structured data only.
Not in XML.

Numeric

The number of vendors returned in the General prefer ences.

+ <PropNumAry>

Array

n/a

+ <PropNumInfo>

FieldSet

n/a

Numeric

Alphanumeric

<Rate>

Alphanumeric

+ <VCodeAry>

Array

n/a

+ <VCode>

FieldSet

n/a

<Vnd>

Character

Alphanumeric

<Rate>

Alphanumeric

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

+ <HotelAvailability>

6101 8.0

<Type>

Alpha

Status of the request
P=Property List returned. Full response consists of Header Brochure Text (optional), and Number of Properties Returned property records (6102).
S=Similar Name List returned. Full response consists of this field and the similar names, found in Section D-8, transaction 6181.
E=Error message returned. Full response consists of only the error message.

The next two fields are conditional and will only exist if the Type Response Returned field is E.

+ <TypeEQual>

[Qualified By: Type of E]

FieldSet

n/a

<Msg>

Character

<Num>

Character

The remainder of the record will appear when the Type Response Returned field is P.
Start Header Section

+ <TypePQual>

[Qualified By: Type of P]

FieldSet

n/a

Alpha

T = Travelscreen
C = Generic unbiased
U = Standard Spectrum

Numeric

CCYYMMDD (Century, Year, Month, Day), e.g., 19951115. This is the date the customer will arrive (check in) at the hotel.

<EndDt>

Numeric

CCYYMMDD (Century, Year, Month, Day), e.g., 19951115. This is the date the customer will leave (check out) the hotel.

Numeric

Right justified, zero filled. The number of nights entered by the customer or as calculated by the PC.

<City>

Alpha

Three-character city code for the city being searched. Only applies to a standard HOA search, 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 a 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, it is used to determine the type of date 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.
Blank if Response Category is T (TravelScreen). Only Reference Point is allowed with TravelScreen.

<State>

Alpha

State code for the city being searched. Only applies to a standard HOA search.

Alpha

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

Numeric

This is the number of adults. Will be 1 or 2.

Numeric

The number of properties returned from all 6102 blocks in this response.

Numeric

Number of preferred properties returned from all 6102 blocks in this response. This is only applicable for TravelScreen. Field will be blank for all other Response Categories.

Numeric

Must be 0 or 1. Identifies the number of text line returned in Chain Brochure Text in this header.

+ <ChainSearchStatusAry>

Array

n/a

Numeric

Used for non-property-specific HOA results. Repeats 6 times, one for each chain qualifier used, in the order requested.
0=Successful or not requested
1=Invalid chain code
2=No properties found for this chain in city
3=No properties available for specified dates

+ <PropSearchStatusAry>

Array

n/a

Numeric

Used in the case of property-specific HOA results.
Repeats 4 times, one 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

Character

Y = Neutral Availability returned - no match on preferences found.
N = Neutral Availability not returned in 6102 response block.
Blank if Response Category other than T (TravelScreen)

Character

Reserved for future use

Alpha

Indicates whether or not there are additional properties which qualify.
For Standard HOA -
Y=There may be more properties, so a next HOA request is valid
N=No more properties for current criteria
For Property Specific HOA - Not applicable, always N

Numeric

The total number of properties which have been returned. This is the same as the Number Properties Returned for the initial HOA response and is incremented by each HOA response.

Numeric

Data Base key for start of the property chain.
For each response to a standard HOA, this should be moved to the Next HOA request. In all other cases it can be ignored.

Numeric

Data Base Key for end of property chain.
For each response to a standard HOA this should be moved to the Next HOA request. In all other cases it can be ignored.

Numeric

Data Base Key for current position of property chain.
For each response to a standard HOA this should be moved to the Next HOA request. In all other cases it can be ignored.

Numeric

Indicates if the corresponding slot in the slot array was used to qualify the properties returned. The sequence returned is in priority order.
0=Relaxed or not used
1=Properties qualified

<Rsvd>

Character

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.

<ChainBrochureTxt>
[Qualified By: NumBrochureLines of 1]

Alphanumeric

Conditional, depending on value of Number of Brochure Lines, maximum of 1.

+ <HotelAvailabilityPropList>

6102 8.0

This detail block will be repeated one or more times when there is a successful return from the avail ability request; the Type Response Returned field= P, and the response is for an HOA request. It is transaction type 6102.
ChainCodeCnt Structured data only. Not in XML.	Numeric	2	The number of properties returned in this block. A maximum of 8 is allowed in each property record block.

Numeric

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

+ <ChainCodeAry>

Array

n/a

+ <ChainCode>

FieldSet

n/a

<Chain>

Alpha

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

Numeric

Property's RoomMaster Number

Alphanumeric

Short name of property

Alphanumeric

Property's short address

Alpha

The 3-character primary city code for the property, left justified, blank filled

<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

Alpha

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

Alpha

Y= Rates guaranteed
N= Not guaranteed

Alpha

Y= Alternate rate guaranteed
N= Alternate rate not guaranteed
Blank if no alternate currency exists.

Alphanumeric

Property's check in deposit requirements:
G= Guarantee required
D= Deposit required to hold room
01-12=Numeric Hour. Late check in time without requiring a guarantee.

Character

L= Link partner
I= Inside Availability Link
R= RoomMaster only participant

Character

Blank if no rating exists, or a value from 1 to 5. Not applicable for TravelScreen.

Character

Y= Spectrum advertiser
N= Not an advertiser

Alpha

Y= Geo Code Data exists
N= Geo Code Data does not exist
For non-GI sponsored products this field will be N.

Alpha

Currency used for rate quotes

Alpha

Alternate currency used for alternate rate quotes. Blank if no alternate currency exists.

Numeric

The number of places to the right of the implied decimal for which the currency rate is quoted

Numeric

The number of places to the right of the implied decimal for which the alternate currency rate is quoted. If ALTERNATE CURRENCY is blank ignore this field.

Alpha

Y= Indicates if the property has more than 8 rates that are returned in a standard availability
N= Indicates if the property does not have more than 8 rates returned

NumRatesReturned
Structured data only.
Not in XML.

Numeric

1 to 8. Identifies the number of rates returned.

+ <GeoCodeIndYQual>

[Qualified By: GeoCodeInd of Y]

FieldSet

n/a

Data for the Property Latitude and Longitude will only be included for GI sponsored products.
<LatSign>	Character	1	Blank= North of Equator -= South of Equator

<Lat>

Numeric

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

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

+ <BICAry>

Array

n/a

+ <BICInfo>

FieldSet

n/a

<BIC>

Alphanumeric

The booking code for this rate which is used at sell time

Alpha

Indicates if there are more rates for this booking code
Y= More rates exist
N= No more rates

Alpha

N= Need status
S=OK to sell

Alpha

Determines if the rate changes during the length of stay
Y= Rate changes
N= No change over the period

Alpha

The category of this rate:
R=RAC
C= Corporate
W= Weekend
P= Package
S= Senior Citizen
G= Government
M= Military
B= Club
A= Association
F= Family Plan
T= Tour
I= Travel Industry
V= Convention
L= Special
N= Negotiated

Alphanumeric

The rate code shown to a travel agent (Customer does not see this). It may or may not be the first 3 characters of the booking code.

Numeric

The room amount expressed in the currency defined by Default Currency Location of implied decimal point specified by Number of Implied Decimals

<AltRateAmt>
[Qualified By: AltRateGuarInd of N,Y]

Numeric

The room amount expressed in the currency defined by the Alternate Currency of implied decimal point specified by Number of Decimals for Alternate Currency. This field not present if Alternate Currency is blank.

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