|
+ Responses
|
|
+ <HtlRules>
|
6131 10.1
|
|
+ <RateComments>
|
HOVI 2.0
|
|
|
|
<PaymentInd>
|
Alpha
|
1
|
Field Description:
Indicates if a guarantee or deposit is required for the rate(s).
Format (a-alpha):
a
Possible Values (List):
G - Guarantee required
D - Deposit required
P - Prepayment is required
blank - no guarantee/deposit required
How is null data specified?
Blank
What does null data indicate?
No guarantee or deposit is required
|
|
+ <CommentTypeAry>
|
Array
|
n/a
|
|
|
+ <CommentType>
|
FieldSet
|
n/a
|
|
|
<Dt>
|
Numeric
|
8
|
Field Description:
This is the date the accompanying rate applies to.
Format (n-numeric):
nnnnnnnn
Special Format:
CCYYMMDD
Examples:
20031030
20030912
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<Freq>
|
Alpha
|
1
|
Description of Field:
Indicates if the specified rate is a nightly rate or the total for the entire stay.
Format (a-alpha):
a
Possible Values (List):
A = Approximate Total
N = Nightly
P = Approximate Total Plus
T = Total amount for the stay per room
How is null data specified?
Character blank.
What does null data indicate?
Blank = Nightly
|
|
<Crncy>
|
Alpha
|
3
|
Field Description:
This is currency the rate is expressed in.
Format (a-alpha):
aaa
Examples:
USD
CAD
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<Amt>
|
Numeric
|
9
|
Field Description:
This is the rate.
Format (n-numeric):
nnnnnnnnn
Special Format:
Left justified, zero filled
Examples:
000008950
000014900
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<DecPos>
|
Numeric
|
1
|
Field Description:
This is the number of decimals for the currency the rate is expressed in.
Format (n- numeric):
n
Possible Values (Range):
0 - 3
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<NumNights>
|
Numeric
|
2
|
Field Description:
This is the number of nights the rate applies to
Format (n- numeric):
nn
Special Format:
Left justified, zero filled
Possible Values (Range):
01 - 99
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
|
|
|
|
|
|
+ <HotelPayment>
|
HTBR 1.0
|
|
|
|
<IndexNum>
|
Numeric
|
3
|
Description of Field:
Unique index number associated with a booking code. This will tie together KLRs within a Booking Code group.
Format (n-numeric):
NNN
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<CredRequired>
|
Alpha
|
1
|
Description of Field:
Indicates whether or not credentials are required for booking
Format (a-alpha):
A
List of Possible Values:
Y = Credentials are required
N = Credential are not required
How is null data specified?
Character blank
What does null data indicate?
No data received from vendor.
|
|
<AmtInd>
|
Alpha
|
1
|
Description of Field:
Deposit / Guarantee / Prepayment required for booking
Format (a-alpha):
A
List of Possible values:
D = Deposit required
G = Guarantee required
P = Prepayment is required
NOTE: If value is "D" (Deposit Required), and (HotelCancel) HTCP / (NonRefundStayInd) in the HOV (HotelRules) response has the value " " (blank) or "N", a deposit is required. However, the vendor may allow a partial refund based on the Cancel date. See the Hotel Rules response for detailed cancellation policies for this room.
How is null data specified?
Character blank
What does null data indicate?
No data received from vendor.
|
|
<PmtDt>
|
Alphanumeric
|
8
|
Description of Field:
The date before a deadline for a payment goes into effect. It is expressed in the date at the property's location.
Format (C - century; Y - year; M - month; D - day):
CCYYMMDD
Examples:
20050102 = Jan 2, 2005
20091231 = Dec 31, 2009
How is null data specified?
Character blanks
What does null data indicate?
No data received from vendor.
|
|
<PmtTm>
|
Numeric
|
4
|
Description of Field: The time before a deadline for a payment goes into effect. It is expressed in the time at the property's location.
Format (N -numeric):
NNNN
The time will be in a 24 hour clock format.
HHMM : 1800, 0700
|
|
<TmOffsetInd>
|
Alpha
|
2
|
Description of Field:
This will indicate how the following unit of time Off-set is applied to the above date.
Format (A -alpha):
AA
Possible Values:
AB = After booking indicator.
Indicates that the above date/time is the booking date/time and the following unit of time Off-set is used to calculate the actual deadline for a payment after the booking date/time.
BA = Before arrival indicator.
Indicates that the above date/time is the arrival date/time and the following unit of time Off-set is used to calculate the actual deadline for a payment in advance of the arrival.
|
|
<TmOffset>
|
Alphanumeric
|
6
|
Description of Field:
This is the optional units of time Off-set before or after the date/time that apply to the deadline. If the above date is the arrival date, these units are used to calculate the actual deadline for a payment in advance of the arrival. If the above date is the booking date, these units are used to calculate the actual deadline for a payment after the booking date.
Format (x-alpha/numeric):
xxxxxx
YR-###, MO-###, DY-### or HR-###, where ### is the number of units.
For example, if the preceding date is the arrival date and this field contained DY-002, the actual deadline for a payment is two days before the arrival date. If the preceding date is the booking date and this field contained MO-003, the actual deadline for a payment is three months after the booking date.
How is null data specified?
Character blank
What does null data indicate?
This data item is not present in vendor's response
|
|
<HoldExpTm>
|
Alphanumeric
|
4
|
Description of Field:
The time at which the room reservation will be released without a deposit/guarantee.
Format (H - hour; M - minute):
HHMM
Example:
1730 = The reservation will only be held until 5:30 pm if a deposit or guarantee is not received
How is null data specified?
Character blank
What does null data indicate?
No data from vendor
|
|
<Amt>
|
Alphanumeric
|
9
|
Description of Field:
This will contain the amount of guarantee / deposit / prepayment that is required by the above mentioned date.
Format (x-alpha/numeric):
xxxxxxxxx
How is null data specified?
Character blank
What does null data indicate?
This data item is not present in vendor's response
|
|
|
|
+ <HotelCreditCard>
|
HTCC 1.0
|
|
|
|
<IndexNum>
|
Numeric
|
3
|
Description of Field: Unique index number associated with a booking code. This will tie together KLRs within a Booking Code group.
Format (n-numeric): NNN
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
+ <AcceptedCCAry>
|
Array
|
n/a
|
|
|
<Type>
|
Alpha
|
2
|
Description of Field:
This will contain one 2-character ID of one of the acceptable credit cards,
e.g. AX for American Express, VI for Visa, etc.
Format (a-alpha,):
aa
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
|
|
|
|
+ <HotelCancel>
|
HTCP 1.0
|
|
|
|
<IndexNum>
|
Numeric
|
3
|
Description of Field: Unique index number associated with a booking code. This will tie together KLRs within a Booking Code group.
Format (n-numeric): NNN
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<NonRefundStayInd>
|
Alpha
|
1
|
Description of Field:
Indicates whether this stay is "Non-Refundable"
Y = This IS a "non-refundable" item
N = This is NOT a "non-refundable" item. (which means it may be partially or totally refundable). See note in Null Data indicator description below.
Format (a-alpha):
A
How is null data specified?
Character blank
What does null data indicate?
Null data can indicate one of two things:
1. This data item is not present in vendor 's response.
2. If the value is blank or N, and the value in the HTBR (HotelPayment) /Deposit / Guarantee / Prepayment Indicator (AmtInd) = D, the vendor may allow a partial refund based on the cancel date. See the Hotel Rules response to verify.
|
|
<CancelDt>
|
Alphanumeric
|
8
|
Description of Field:
Last date the reservation can be canceled without penalty.
Expressed in the date at the property's location.
Format (C-century; Y-year; M-month; D-day):
CCYYMMDD
Examples:
20050122
20051101
How is null data specified?
Character blank
What does null data indicate?
This data item is not present in vendor's response
|
|
<CancelTm>
|
Alphanumeric
|
4
|
Description of Field: Last time the reservation can be canceled without penalty expressed in the time at the property's location.
Format (x- alpha/numeric): xxxx
The time will be in a 24 hour clock format.
HHMM, e.g. 1800, 0700
How is null data specified?
Character blank
What does null data indicate?
This data item is not present in vendor's response
|
|
<TmOffsetInd>
|
Alpha
|
2
|
Description of Field: This will indicate how the following unit of time Off-set is applied to the above date/time.
Format (A -alpha): AA
Possible Values:
AB = After booking indicator. Indicates that the above date/time is the booking date/time and the following unit of time Off-set is used to calculate the actual cancellation date after the booking date/time.
BA = Before arrival indicator
Indicates that the above date/time is the arrival date/time and the following unit of time Off-set is used to calculate the actual cancellation date in advance of the arrival.
|
|
<TmOffset>
|
Alphanumeric
|
6
|
Description of Field:
This is the optional units of time Off-set. It can only be used if the preceding cancel date is the booking date or the arrival date. If the cancel date is the arrival date, these units are used to calculate the actual cancellation date in advance of the arrival. If the cancel date is the booking date, these units are used to calculate the actual cancellation date after the booking date.
Format (x-alpha/numeric):
xxxxxx
The format is YR-###, MO-###, DY-### or HR-###, where ### is the number of units. For example, if the preceding cancel date is the arrival date and this field contained DY-002, the actual cancellation date is two days before the arrival date. If the preceding cancel date is the booking date and this field contained MO-003, the actual cancellation date is three months after the booking date.
How is null data specified?
Character blank
What does null data indicate?
This data item is not present in vendor's response
|
|
<TaxInd>
|
Alpha
|
1
|
Description of Field:
Indicates whether or not the Penalty amount includes taxes.
Y = Taxes are included
N = Taxes are not included
Format (a-alpha):
a
How is null data specified?
Character blank
What does null data indicate?
This data item is not present in vendor's response
|
|
<FeeInd>
|
Alpha
|
1
|
Description of Field:
Penalty amount contains fees
Y = Fees are included
N = Fees are not included
Format (a-alpha):
a
How is null data specified?
Character blank
What does null data indicate?
This data item is not present in vendor's response
|
|
<PenaltyAmt>
|
Alphanumeric
|
9
|
Description of Field:
This will contain the cancellation penalty amount
Format (x-alpha/numeric)
xxxxxxxxx
How is null data specified?
Character blank
What does null data indicate?
This data item is not present in vendor's response
|
|
<NumNights>
|
Alphanumeric
|
2
|
Description of Field:
This will contain the number of nights that will be assessed as the cancelation penalty.
Format (x-alpha/numeric)
xx
How is null data specified?
Character blank
What does null data indicate?
This data item is not present in vendor's response
|
|
<PenaltyPercent>
|
Alphanumeric
|
3
|
Description of Field:
This will contain the cancellation penalty expressed as a percentage of
the following basis unit.
Format (x-alpha/numeric)
xxx
How is null data specified?
Character blank
What does null data indicate?
This data item is not present in vendor's response
|
|
<PercentAppliesTo>
|
Alpha
|
To End
|
This will contain the cost qualifier that explains what the percentage is applied to in order to calculate the cancel penalty.
Format (a-alpha)
AAAAAAAAA...
Possible Values:
"FullStay",
"Nights" ,
"FirstLast".
How is null data specified?
Character blank
What does null data indicate?
This data item is not present in vendor's response
|
|
|
|
+ <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
|
64
|
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
|
4
|
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.
|
|
<ErrSeverityInd>
|
Character
|
1
|
F= Fatal error, processing halted
W= Warning , processing continued
|
|
|
|
|
|
|
|
+ <HotelExtraCharges>
|
HTEX 1.0
|
|
|
|
<IndexNum>
|
Numeric
|
3
|
Description of Field:
Unique index number associated with a booking code. This will tie together KLRs within a Booking Code group.
Format (n-numeric):
NNN
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<ExtraAdultAmt>
|
Alphanumeric
|
9
|
Description of Field:
Total amount charged for all extra adults. Amount is expressed in the stored currency.
Format (n-numeric):
nnnnnnnnn
How is null data specified?
Character blank
What does null data indicate?
Extra adult charge is not included in the total.
|
|
<ExtraChildAmt>
|
Alphanumeric
|
9
|
Description of Field:
Total amount charged for all extra children.
Amount is expressed in the stored currency.
Format (n-numeric):
nnnnnnnnn
How is null data specified?
Character blank
What does null data indicate?
Extra child charge is not included in the total.
|
|
<AdultRollawayAmt>
|
Alphanumeric
|
9
|
Description of Field:
Total amount charged for all extra adult rollaways.
Amount is expressed in the stored currency.
Format (n-numeric):
nnnnnnnnn
How is null data specified?
Character blank
What does null data indicate?
Adult rollaway charge is not included in the total.
|
|
<CribAmt>
|
Alphanumeric
|
9
|
Description of Field:
Total amount charged for Cribs.
Amount is expressed in the stored currency.
Format (n-numeric):
nnnnnnnnn
How is null data specified?
Character blank
What does null data indicate?
Crib charge is not included in the total.
|
|
|
|
+ <HotelMatch>
|
HTMQ 1.0
|
|
|
|
Start Definition Of HTMQ
|
|
<IndexNum>
|
Numeric
|
3
|
Description of Field:
Unique index number associated with a booking code. This will tie together KLRs within a Booking Code group.
Format (n-numeric):
NNN
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<RateCatMatch>
|
Alpha
|
1
|
Field Description:
This field indicates if Rate Category Qualifier is matched by a vendor
Format (a-alpha):
a
Possible Values:
Y = This rate is for the requested rate category.
N = This rate is not for the requested rate category. The following RC field will contain a substituted rate category.
How is null data specified?
Character blank
What does null data indicate?
A rate category does not apply to this rate.
Blank can also indicate that the qualifier was not requested.
|
|
<RoomCntMatch>
|
Alpha
|
1
|
Field Description:
This field indicates if number of requested rooms is matched by a vendor.
Format (a-alpha):
a
Possible Values:
Y = The number of rooms requested is available.
N = The number of rooms requested is not available. This number available is listed in the following Number of Rooms field.
M = The number of rooms requested exceeded the maximum allowed. This maximum is listed in the following Number of Rooms field.
How is null data specified?
Character blanks
What does null data indicate?
The qualifier was not requested.
|
|
<AdultCntMatch>
|
Alpha
|
1
|
Field Description:
This field indicates if requested number of adults is matched by a vendor.
Format (a-alpha):
a
Possible Values:
Y = This number of adults requested is allowed for the number of rooms requested
N = This number of adults requested is not allowed for the number of rooms requested. The maximum allowed is listed in the following Number of Adults field.
How is null data specified?
Character blanks
What does null data indicate?
The qualifier was not requested.
|
|
<ChildCntMatch>
|
Alpha
|
1
|
Field Description:
This field indicates if requested number of children is matched by a vendor.
Format (a-alpha):
a
Possible Values:
Y = This number of children requested is allowed for the number of rooms requested.
N = This number of children requested is not allowed for the number of rooms requested. This maximum allowed is listed in the following Number of Children field.
How is null data specified?
Character blanks
What does null data indicate?
The qualifier was not requested.
|
|
<BedMatch>
|
Alpha
|
1
|
Field Description:
This field indicates if requested bedding type is matched by a vendor.
Format (a-alpha):
a
Possible Values:
Y = The number and type of beds requested are available for this rate.
N = The number and/or type of beds requested are not available for this rate.
S = A substitute has been offered for the originally requested number and/or type of beds.
How is null data specified?
Character blanks
What does null data indicate?
The qualifier was not requested.
It also may indicate that number and/or type of beds at this particular property is unknown.
|
|
<AdultRollawayMatch>
|
Alpha
|
1
|
Field Description:
This field indicates if requested number of adult rollaways is matched by a vendor.
Format (a-alpha):
a
Possible values:
Y = The number of adult rollaways requested are available.
N = The number of adult rollaways requested are not available
How is null data specified?
Character blanks
What does null data indicate?
The qualifier was not requested.
It also may indicate that number or availability of adult rollaways at this particular property is unknown.
|
|
<ChildRollawaysMatch>
|
Alpha
|
1
|
Field Description:
This field indicates if requested number of child rollaways is matched by a vendor.
Format (a-alpha):
a
Possible values:
Y = The number of child rollaways requested are available.
N = The number of child rollaways requested are not available
How is null data specified?
Character blanks
What does null data indicate?
The qualifier was not requested.
It also may indicate that number or availability of child rollaways at this particular property is unknown.
|
|
<CribMatch>
|
Alpha
|
1
|
Field Description:
This field indicates if requested number of cribs is matched by a vendor.
Format (a-alpha):
a
Possible values:
Y = The number of cribs requested are available.
N = The number of cribs requested are not available
How is null data specified?
Character blanks
What does null data indicate?
The qualifier was not requested.
It also may indicate that number or availability of cribs at this particular property is unknown.
|
|
<RateCat>
|
Alphanumeric
|
3
|
Description of Field:
The Rate category associated with the room rate in OTA codes.
It will consist of an alpha code followed by a two position number.
Format (x-alphanumeric):
xxx (ann)
Possible Values (List):
A09 - Association
B14 - Club
C02 - Corporate
F08 - Family Plan
G03 - Government
I13 - Travel Industry
L11 - Special
M04 - Military
P05 - Package
R01 - Regular or Rack
S06 - Senior Citizen
T10 - Tour
V12 - Convention
W07 - Weekend
Z15 - All
How is null data specified?
Character blank
What does null data indicate?
Rate Access Code applies to this rate.
|
|
<RoomCnt>
|
Numeric
|
1
|
Description of Field:
If the original number of rooms requested exceeded what was available at that time, this will contain the number of rooms that are available. Or if the maximum number of rooms that can be requested has been exceeded, this will contain the maximum number.
Format ( n-numeric):
n
How is null data specified?
Character blank
What does null data indicate?
This search qualifier was not in the request.
|
|
<AdultCnt>
|
Numeric
|
1
|
Description of Field:
If the original number of adults requested exceeds the maximum allowed for the number of bedding types/rooms requested, this will contain the maximum number of adults allowed.
Format (n-numeric):
n
How is null data specified?
No data results in error
What does null data indicate?
No data results in error
.
|
|
<ChildCnt>
|
Numeric
|
1
|
Description of Field:
If the original number of children requested exceeds
the maximum allowed for the number of rooms requested, this will contain the maximum number of children allowed
Format ( n-numeric):
n
How is null data specified?
Character blank.
What does null data indicate?
This search qualifier was not in the request.
.
|
|
<BedType>
|
Character
|
3
|
Description of Field:
This will be 3 characters to represent the number of beds and bedding type in the room for the adults and children listed above. The first position will remain to support functionality that exists today.
The 3rd character will be as follows:
D = Double bed
F = Futon
K = King
M = Murphy bed
Q = Queen
S = Sofa bed
I = Tatami mats
T = Twin
This field is the bedding originally requested or a substitute.
Format ( x-alpha/numeric):
X
How is null data specified?
Character blank
What does null data indicate?
This search qualifier was not in the request.
|
|
|
|
+ <HotelRateIncludes>
|
HTRI 1.0
|
|
|
|
<IndexNum>
|
Numeric
|
3
|
Description of Field
Index Number:
A unique index number associated with a booking code. This will tie together KLRs within a Booking Code group. This field is not used in HOV response.
Format (n-numeric):
NNN
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<RateCat>
|
Alphanumeric
|
3
|
Description of Field
The Rate Category:
Code associated with the room rate. This field is not used in HOV response.
Rate category and Rate Access Code are mutually exclusive. This field won't be populated in HOC response if a rate category is requested by a subscriber and a vendor returns rate category information along with a rate category match indicator. In this case this field will be blank and a rate category field will be populated in HTMQ KLR.
Format (x-alpha/numeric):
xxx
Possible Values (List):
A09 = Association
B14 = Club
C02 = Corporate
F08 = Family Plan
G03 = Government
I13 = Travel Industry
L11 = Special
M04 = Military
P05 = Package
R01 = Regular or Rack
S06 = Senior Citizen
T10 = Tour
V12 = Convention
W07 = Weekend
How is null data specified?
Character blank
What does null data indicate?
Blank = Rate Access Code applies to this rate instead.
|
|
<CommissionInd>
|
Alpha
|
1
|
Description of Field
Commissionable Rate Indicator:
Indicates if the rate is commissionable.
Format (a-alpha):
a
Possible Values:
Y =Commissionable
N =Not commissionable
D = See HTRX KLR for Commission percentage value
How is null data specified?
Character blank
What does null data indicate?
Blanks = unknown if rate is commissionable.
|
|
<SmokingInd>
|
Alpha
|
1
|
Description of Field
Smoking Room Indicator:
Indicates if the room is designated as nonsmoking or smoking.
Format (a-alpha):
a
Possible Values (List):
Y = Smoking
N = Nonsmoking
How is null data specified?
Character blank
What does null data indicate?
Blank = smoking / nonsmoking status unknown.
|
|
<RoomView>
|
Alphanumeric
|
2
|
Description of Field
View From The Room expressed in OTA codes.
Possible Values (List):
01 = Airport View
02 = Bay View
03 = City View
04 = Courtyard View
05 = Golf View
06 = Harbor View
07 = Intercoastal View
08 = Lake View
09 = Marina View
10 = Mountain View
11 = Ocean View
12 = Pool View
13 = River View
14 = Water View
How is null data specified?
Character blank
What does null data indicate?
Blank = Information about view from the room is unknown
|
|
<BreakfastInd>
|
Alpha
|
1
|
Description of Field
Breakfast Indicator:
Indicates whether breakfast is included in the rate. The meal is provided daily.
Format (a-alpha):
A
Possible Values :
Y = Breakfast is included
N = Breakfast is not included
How is null data specified?
Character blank
What does null data indicate?
Blank = Meal information is unavailable
|
|
<LunchInd>
|
Alpha
|
1
|
Description of Field
Lunch Indicator:
Indicates whether lunch is included in the rate. The meal is provided daily.
Format (a-alpha):
A
Possible Values
Y = Lunch is included
N = Lunch is not included
How is null data specified?
Character blank
What does null data indicate?
Blank = Meal information is unavailable
|
|
<DinnerInd>
|
Alpha
|
1
|
Description of Field
Dinner Indicator:
Indicates whether dinner is included in the rate. The meal is provided daily.
Format (a-alpha):
A
Possible Values :
Y = Dinner is included
N = Dinner is not included
How is null data specified?
Character blank
What does null data indicate?
Blank = Meal information is unavailable
|
|
+ <MealPlanAry>
|
Array
|
n/a
|
|
|
<MealPlan>
|
Alphanumeric
|
2
|
Description of Field
Meal Plan expressed in OTA codes.
Possible Values (List):
01 = All inclusive
02 = American
03 = Bed & breakfast
04 = Buffet breakfast
05 = Caribbean breakfast
06 = Continental Breakfast
07 = English breakfast
08 = European plan
09 = Family plan
10 = Full board
11 = Full breakfast
12 = Half board/modified American plan
13 = As Brochured
14 = Room Only
15 = Self Catering
16 = Bermuda
17 = Dinner Bed and Breakfast Plan
18 = Family American
19 = Breakfast
How is null data specified?
Character blank
What does null data indicate?
Blank = Information is unavailable
|
|
|
|
|
|
+ <HotelRateExtension>
|
HTRX 1.0
|
|
|
|
<IndNum>
|
Numeric
|
3
|
Description of Field
Index Number:
A unique index number associated with a booking code. This will tie together KLRs within a Booking Code group. This field is not used in HOV response.
Format (n-numeric):
NNN
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<CommRatePerVal>
|
Alpha
|
2
|
Description of Field
Commissionable Rate Percentage value. Data will be present in this field if HTRI KLR has 'D' in commissionable rate indicator field.
Format (n-numeric):
nn
How is null data specified?
Character blank
What does null data indicate?
Blanks = unknown if rate is commissionable.
|
|
|
|
+ <HotelSurchargeTax>
|
HTST 1.0
|
|
|
|
<IndexNum>
|
Numeric
|
3
|
Description of Field:
Unique index number associated with a booking code. This will tie together KLRs within a Booking Code group.
Format (n-numeric):
NNN
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<Total>
|
Alphanumeric
|
9
|
Description of Field:
Total Taxes and Surcharges for the stay.
This field is to be used by hotel vendors that can not separate the total surcharges from the total taxes.
If this field is present, the following two fields need not be.
Format (x-alpha/numeric):
xxxxxxxxx
How is null data specified?
Character blank
What does null data indicate?
Total taxes and total surcharges are sent separately.
|
|
<TotTax>
|
Alphanumeric
|
9
|
Description of Field:
Total Taxes for the Stay
Format (x-alpha/numeric):
xxxxxxxxx
How is null data specified?
Character blank
What does null data indicate?
Total Taxes and Surcharges field is used instead.
|
|
<TotSurcharges>
|
Alphanumeric
|
9
|
Description of Field:
Total Surcharges for the Stay
Format (x-alpha/numeric):
xx
How is null data specified?
Character blank
What does null data indicate?
Total Taxes and Surcharges field is used instead.
|
|
+ <TaxbreakoutAry>
|
Array
|
n/a
|
|
|
+ <TaxbreakoutItem>
|
FieldSet
|
n/a
|
|
|
<Amt>
|
Numeric
|
9
|
Description of Field:
Tax break-out amount
Format (n-numeric):
nnnnnnnnn
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<Description>
|
Numeric
|
2
|
Description of Field:
OTA code describing the tax type.
NOTE: This is a pass-through of the
OTA tax table FTT. Values 01-99 are supported, but not necessarily listed. See the latest list at OpenTravel.org.
Format (n-numeric):
nn
Possible Values:
01 - Bed tax
02 - City hotel fee
03 - City tax
04 - County tax
05 - Energy tax
06 - Federal tax
07 - Food & beverage tax
08 - Lodging tax
09 - Maintenance fee
10 - Occupancy tax
11 - Package fee
12 - Resort fee
13 - Sales tax
14 - Service charge
15 - State tax
16 - Surcharge
17 - Total tax
18 - Tourism tax
19 - VAT/GST tax
20 - Surplus Lines Tax
21 - Insurance Premium Tax
22 - Application Fee
23 - Express Handling Fee
24 - Exempt
25 - Standard
26 - Zero-rated
27 - Miscellaneous
28 - Room Tax
29 - Early Checkout Fee
30 - Country Tax
31 - Extra Person Charge
32 - Banquet Service Fee
33 - Room Service Fee
34 - Local Fee
35 - Goods and Services Tax (GST)
36 - Value Added Tax (VAT)
37 - Crib Fee
38 - Rollaway Fee
39 - Assessment/License Tax
40 - Pet Sanitation Fee
41 - Not Known
42 - Child Rollaway Charge
43 - Convention Tax
44 - Extra Child Charge
45 - Standard Food and Beverage Gratuity
46 - National Government Tax
47 - Adult Rollaway Fee
48 - Beverage with Alcohol
49 - Beverage without Alcohol
50 - Tobacco
51 - Food
52 - Total Surcharges
53 - State Cost Recovery Fee
54 - Miscellaneous Fee
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
|
|
|
|
|
|
+ <HotelType>
|
HTTR 1.0
|
|
|
|
<HtlTypeInd>
|
Alphanumeric
|
1
|
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
|
|
|
|
+ <HotelPropertyAddress>
|
HTVA 1.0
|
|
|
|
+ <PropAddrAry>
|
Array
|
n/a
|
|
|
<PropAddr>
|
Alphanumeric
|
64
|
Field Description:
Address of the hotel property
Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Special Format:
N/A
Examples:
123 Main Street
Anycity, Anystate 12345
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
|
|
|
|
+ <HotelRateDescription>
|
HTVB 1.0
|
|
|
|
+ <DescriptionAry>
|
Array
|
n/a
|
|
|
<Description>
|
Alphanumeric
|
64
|
Field Description:
Description of the rates for the room for the days indicated.
Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Special Format:
N/A
Examples:
89.00 starting 23Jun for 4 nights
102.00 23Jun through 27Jun
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
|
|
|
|
+ <HotelRateQualification>
|
HTVC 1.0
|
|
|
|
+ <QualificationAry>
|
Array
|
n/a
|
|
|
<Qualification>
|
Alphanumeric
|
64
|
Field Description:
Text that qualifies the rates.
Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Special Format:
N/A
Examples:
TAXES NOT INCLUDED IN RATE
14.10 PCT SALES TAX/VAT
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
|
|
|
|
+ <HotelPropertyInfo>
|
HTVD 1.0
|
|
|
|
<PropName>
|
Alpha
|
35
|
Field Description:
Full name of the hotel property
Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Special Format:
N/A
Examples:
Radisson Hotel
Ritz-Carlton on the Plaza
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<PhoneNum>
|
Alphanumeric
|
17
|
Field Description:
Property phone number
Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxx
Special Format:
N/A
Examples:
303-123-4567
44-207-493-7222
How is null data specified?
The field is blanks
What does null data indicate?
The property has no phone
|
|
<FaxNum>
|
Alphanumeric
|
17
|
Field Description:
Property fax number
Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxx
Special Format:
N/A
Examples:
303-123-4567
44-207-493-7222
How is null data specified?
The field is blanks
What does null data indicate?
The property has no fax number.
|
|
<TelexNum>
|
Alphanumeric
|
17
|
Field Description:
Phone number for an old fashioned Telex machine
Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxx
Special Format:
N/A
Examples:
303-123-4567
44-207-493-7222
How is null data specified?
The field is blanks
What does null data indicate?
The property has no Telex machine.
|
|
<HtlInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, the property is a hotel.
Format (x-alpha/numeric):
Y=Property is this type
N=Property is not this type
Special Format:
N/A
Examples:
Y
N
How is null data specified?
The field is blank
What does null data indicate?
Blank = N
|
|
<MotelInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, the property is a Motel.
Format (x-alpha/numeric):
Y=Property is this type
N=Property is not this type
Special Format:
N/A
Examples:
Y
N
How is null data specified?
The field is blank
What does null data indicate?
Blank = N
|
|
<InnInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, the property is an inn.
Format (x-alpha/numeric):
Y=Property is this type
N=Property is not this type
Special Format:
N/A
Examples:
Y
N
How is null data specified?
The field is blank
What does null data indicate?
Blank = N
|
|
<AllSuitesInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, the property is all suites.
Format (x-alpha/numeric):
Y=Property is this type
N=Property is not this type
Special Format:
N/A
Examples:
Y
N
How is null data specified?
The field is blank
What does null data indicate?
Blank = N
|
|
<CondoInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, the property is condos.
Format (x-alpha/numeric):
Y=Property is this type
N=Property is not this type
Special Format:
N/A
Examples:
Y
N
How is null data specified?
The field is blank
What does null data indicate?
Blank = N
|
|
<VillaInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, the property is a villa.
Format (x-alpha/numeric):
Y=Property is this type
N=Property is not this type
Special Format:
N/A
Examples:
Y
N
How is null data specified?
The field is blank
What does null data indicate?
Blank = N
|
|
<CastleInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, the property is a castle.
Format (x-alpha/numeric):
Y=Property is this type
N=Property is not this type
Special Format:
N/A
Examples:
Y
N
How is null data specified?
The field is blank
What does null data indicate?
Blank = N
|
|
<PensionInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, the property is a pension.
Format (x-alpha/numeric):
Y=Property is this type
N=Property is not this type
Special Format:
N/A
Examples:
Y
N
How is null data specified?
The field is blank
What does null data indicate?
Blank = N
|
|
<ResortInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, the property is a resort.
Format (x-alpha/numeric):
Y=Property is this type
N=Property is not this type
Special Format:
N/A
Examples:
Y
N
How is null data specified?
The field is blank
What does null data indicate?
Blank = N
|
|
<ConventionInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, the property is part of a convention.
Format (x-alpha/numeric):
Y=Property is this type
N=Property is not this type
Special Format:
N/A
Examples:
Y
N
How is null data specified?
The field is blank
What does null data indicate?
Blank = N
|
|
<BedBreakfastInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, the property is a bed and breakfast.
Format (x-alpha/numeric):
Y=Property is this type
N=Property is not this type
Special Format:
N/A
Examples:
Y
N
How is null data specified?
The field is blank
What does null data indicate?
Blank = N
|
|
<OtherTypeInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, the property is some other form of domicile.
Format (x-alpha/numeric):
Y=Property is this type
N=Property is not this type
Special Format:
N/A
Examples:
Y
N
How is null data specified?
The field is blank
What does null data indicate?
Blank = N
|
|
<CheckInTm>
|
Numeric
|
4
|
Field Description:
Check-In time (Military Format)
Format:
nnnn
Special Format:
N/A
Examples:
1100
1600
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<CheckOutTm>
|
Numeric
|
4
|
Field Description:
Check-Out time (Military Format)
Format:
nnnn
Special Format:
N/A
Examples:
0900
1000
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<RoomCnt>
|
Numeric
|
5
|
Field Description:
Number of rooms requested
Format (x-alpha/numeric):
nnnnn
Special Format:
N/A
Examples:
00001
00002
How is null data specified?
The field is blank
What does null data indicate?
No rooms were requested
|
|
<NumSuites>
|
Numeric
|
5
|
Field Description:
Number of suites
Format (x-alpha/numeric):
nnnnn
Special Format:
N/A
Examples:
00011
00005
How is null data specified?
The field is blank
What does null data indicate?
No suites were requested
|
|
<NumFloors>
|
Numeric
|
3
|
Field Description:
Number of floors requested
Format (x-alpha/numeric):
nnn
Special Format:
N/A
Examples:
002
How is null data specified?
The field is blank
What does null data indicate?
No floors were requested
|
|
<ConfRoomCapacity>
|
Numeric
|
5
|
Field Description:
Conference room capacity
Format (x-alpha/numeric):
nnnnn
Special Format:
N/A
Examples:
00311
00405
How is null data specified?
The field is blank
What does null data indicate
No conference room was requested
|
|
<YearBuilt>
|
Numeric
|
4
|
Field Description:
Year hotel was built
Format (x-alpha/numeric):
nnnn
Special Format:
N/A
Examples:
1987
1842
How is null data specified?
The field is blank
What does null data indicate?
The year the property was built is not known.
|
|
<YearRemodeled>
|
Numeric
|
4
|
Field Description:
Year hotel was last remodeled
Format (x-alpha/numeric):
nnnn
Special Format:
N/A
Examples:
1998
2001
How is null data specified?
This field is blank
What does null data indicate?
The property was never remodeled or the year is was remodeled is unknown
|
|
<AAARating>
|
Numeric
|
1
|
Field Description:
Number of AAA diamonds
This field will be blank for non-Galileo companies.
Format (x-alpha/numeric):
n
Special Format:
N/A
Examples:
5
3
How is null data specified?
This field is blank
What does null data indicate?
The AAA rating is unknown or non-existent.
|
|
|
|
+ <HotelPropertyTaxInfo>
|
HTVE 1.0
|
|
|
|
+ <TaxDescriptionAry>
|
Array
|
n/a
|
|
|
<TaxDescription>
|
Alphanumeric
|
64
|
Field Description:
Tax Description Lines
Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Special Format:
N/A
Examples:
Taxes Not Included In Rates
Tax Rate: 14.10 PCT
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
|
|
|
|
+ <HotelDepGuarCreditCard>
|
HTVF 1.0
|
|
|
|
+ <CCAry>
|
Array
|
n/a
|
|
|
<CC>
|
Alpha
|
2
|
Field Description:
This contains the acceptable credit card code
Format (x-alpha/numeric):
aa
Special Format:
N/A
Examples:
AX
VI
CB
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
|
|
|
|
+ <HotelDepositAddress>
|
HTVG 1.0
|
|
|
|
+ <AddrAry>
|
Array
|
n/a
|
|
|
<Addr>
|
Alphanumeric
|
64
|
Field Description:
Text lines containing the address to be used when mailing any required deposit.
Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Special Format:
N/A
Examples:
Send Deposit To: Property Street Address
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
|
|
|
|
+ <HotelCommonHeader>
|
HTVH 2.0
|
|
|
|
<StartDt>
|
Numeric
|
8
|
Field Description:
This is the date the guest arrives at the hotel
Format:
CCYYMMDD (Century, Year, Month, Day)
Special Format:
N/A
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<EndDt>
|
Numeric
|
8
|
Field Description:
This is the date the guest leaves at the hotel
Format:
CCYYMMDD (Century, Year, Month, Day)
Special Format:
N/A
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<NumNights>
|
Numeric
|
2
|
Field Description:
This is the number of nights the guest is staying
Format (x-alpha/numeric):
nn
Special Format:
Right justified, zero filled
Examples:
06
14
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<Vnd>
|
Character
|
3
|
Field Description:
This is the two to three character code used to identify the hotel chain
Format (x-alpha/numeric):
xxx
Special Format:
Left justified, blank filled
Examples:
MC
HI
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<HtlPropNum>
|
Alphanumeric
|
5
|
Field Description:
This is the unique number that identifies a particular property in the RoomMaster database.
Format (x-alpha/numeric):
xxxxx
Examples:
01079
95695
ABCDE
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<BIC>
|
Alphanumeric
|
7
|
Field Description:
This is the unique code that identifies a particular type of room. It may be the code from the RoomMaster database or the code used by the hotel chain.
Format (x-alpha/numeric):
xxxxxxx
Special Format:
Left justified, blank filled
Examples:
A1KRAC
B2T000
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<NumPersons>
|
Numeric
|
1
|
Field Description:
This is the number of adults per room
Format (x-alpha/numeric):
n
Special Format:
N/A
Examples:
4
2
How is null data specified?
N/A
What does null data indicate?
N/A
.
|
|
|
|
+ <HotelCancellationPolicy>
|
HTVI 1.0
|
|
|
|
+ <CancelInfoAry>
|
Array
|
n/a
|
|
|
<CancelInfo>
|
Alphanumeric
|
64
|
Field Description:
This field contains information about cancelling the booked room.
Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Special Format:
N/A
Examples:
Reservations must be cancelled prior to 1600/ 4 PM day of arrival.
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
|
|
|
|
+ <HotelFOPCreditCards>
|
HTVJ 1.0
|
|
|
|
+ <CCAry>
|
Array
|
n/a
|
|
|
<CC>
|
Alpha
|
2
|
Field Description:
This is the code that represents the credit card that is accepted at the hotel property as a form of payment.
Format (x-alpha/numeric):
aa
Special Format:
N/A
Examples:
CB
DS
VI
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
|
|
|
|
+ <HotelFOPDescription>
|
HTVK 1.0
|
|
|
|
+ <FOPInfoAry>
|
Array
|
n/a
|
|
|
<FOPInfo>
|
Alphanumeric
|
64
|
Field Description:
This is text information about alternate forms of payment.
Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Special Format:
Left justified, blank filled
Examples:
MONEY ORDER
COMPANY CHECK
TRAVELER'S CHECKS
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
|
|
|
|
+ <HotelRoomGeneralInfo>
|
HTVL 1.0
|
|
|
|
+ <GeneralInfoAry>
|
Array
|
n/a
|
|
|
<GeneralInfo>
|
Alphanumeric
|
64
|
Field Description:
This describes the room offered for the rate.
Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Special Format:
Left justified, blank filled
Examples:
Room Type: Regular
2 Queens beds/Hairdryer/Microwave
Max Occupany - 5 people
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
|
|
|
|
+ <HotelExtraOptions>
|
HTVN 1.0
|
|
|
|
+ <ExtraOptionAry>
|
Array
|
n/a
|
|
|
<ExtraOption>
|
Alphanumeric
|
64
|
Field Description:
This field contains information about the extra options available in the room requested and the cost associated with each.
Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Special Format:
Left justified, blank filled.
Examples:
Extra Adult - 10.00 USD
Rollaway Adult - 10.00 USD
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
|
|
|
|
+ <HotelRoomDetailedInfo>
|
HTVO 1.0
|
|
|
|
<RoomDescrInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room description information has been provided.
Format (x-alpha/numeric):
Y=Room Description Information provided
N=Room Description Information not provided
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<RoomType>
|
Alpha
|
1
|
Field Description:
Identifies the type of Room
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
S=Suite
J=Junior Suite
C=Cottage
T=Studio
K=Condo
R=Regular
P=Parlor
L=Lanai
V=Villa
E=Efficiency
Blank=N/A
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<RoomLocnView>
|
Alpha
|
2
|
Field Description:
Identifies the location/view of the room
Format (x-alpha/numeric):
aa
Special Format:
N/A
Examples:
BF=Beach Front
OF=Ocean Front
MV=Mountain View
SV=Sea View
PS=Pool Side
GC=Golf Course View
LV=Lake View
RV=River View
PV=Park View
CV=Courtyard View
DO=Drive-up Room
Blank=N/A
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<FloorRangeBegin>
|
Numeric
|
3
|
Field Description:
This field start the range of floors on which this room can be found.
Format (x-alpha/numeric):
nnn
Special Format:
Right justified, zero filled
Examples:
014
001
How is null data specified?
This field will be blanks.
What does null data indicate?
The floor range does not apply to this type of room.
|
|
<FloorRangeEnd>
|
Numeric
|
3
|
Field Description:
This field ends the range of floors on which this room can be found.
Format (x-alpha/numeric):
nnn
Special Format:
Right justified, zero filled
Examples:
026
004
How is null data specified?
This field will be blanks.
What does null data indicate?
The floor range does not apply to this type of room.
|
|
<NumBedrooms>
|
Numeric
|
1
|
Field Description:
Number of bedrooms for this type of room.
Format (x-alpha/numeric):
n
Special Format:
N/A
Examples:
1
3
How is null data specified?
This field will be blank.
What does null data indicate?
The type of room does not support more than one bedroom.
|
|
<AirCondInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has air conditioning.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<BalconyInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has a balcony.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<BathTubInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has a bath tub.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<BidetInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has a bidet.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<Spare1>
|
Alpha
|
1
|
Field Description:
It is not known at this time that this indicator has a function.
Format (x-alpha/numeric):
N=default setting
Special Format:
N/A
Examples:
N
|
|
<ComputerInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room contains a computer.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<ConciergeLevelInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has a concierge available.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<ConnectingRoomsInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room type has connecting rooms.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<ContinentalBreakfastInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room comes with complimentary continental breakfast.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<Spare2>
|
Alpha
|
1
|
Field Description:
It is not known at this time that this indicator has a function.
Format (x-alpha/numeric):
N=default setting
Special Format:
N/A
Examples:
N
|
|
<EfficiencyInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room is categorized as an efficiency room.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<Spare3>
|
Alpha
|
1
|
Field Description:
It is not known at this time that this indicator has a function.
Format (x-alpha/numeric):
N=default setting
Special Format:
N/A
Examples:
N
|
|
<FireplaceInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has a fireplace.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<HandicapFacilitiesInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has facilities accessable to the handicapped.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<KitchenInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has a kitchen.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<Spare4>
|
Alpha
|
1
|
Field Description:
It is not known at this time that this indicator has a function.
Format (x-alpha/numeric):
N=default setting
Special Format:
N/A
Examples:
N
|
|
<Spare5>
|
Alpha
|
1
|
Field Description:
It is not known at this time that this indicator has a function.
Format (x-alpha/numeric):
N=default setting
Special Format:
N/A
Examples:
N
|
|
<MiniBarInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has a mini bar.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<MoviesInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has movies available.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<NoSmokingRoomInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, smoking has not be allowed in this room.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<SmallPetsInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, small pets are allowed in this room.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<PhoneServiceInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, phone service is available in this room.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<RefrigeratorInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has a refrigerator.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<OrientalStyleInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room is decorated Oriental style.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<WesternStyleInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room is decorated Western style.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<SafeInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has a safe.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<SaunaInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has a sauna available.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<ShowerInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has a shower.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<SpaInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has a spa available.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<TVInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has a TV.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<CableTVInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has a cable TV.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<VCRInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has a VCR.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<WaterBedInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has a water bed.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<WCInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has a water closet.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<WetBarInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has a wet bar.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<AC120Ind>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has 120 AC electrical outlets.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DC120Ind>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has 120 DC electrical outlets.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<AC220Ind>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has 220 AC electrical outlets.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DC220Ind>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has 220 DC electrical outlets.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<ModemInd>
|
Alpha
|
1
|
Field Description:
If this indicator is Y, the room has a modem.
Format (x-alpha/numeric):
Y=Room has feature
N=Room does not have feature
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
|
|
+ <HotelRateData>
|
HTVP 1.0
|
|
|
|
<RateCat>
|
Alpha
|
1
|
Field Description:
The category the rate is part of.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
C - Corporate
B - Club
L - Special/Promotional
W - Weekend
R - Regular or Rack
G - Government
M - Military
S - Senior Citizen
A - Association
P - Package
I - Industry
F - Family Plan
T - Tour
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = R or regular rate
|
|
<MinLenStay>
|
Numeric
|
2
|
Field Description:
Minimum number of nights required to qualify for this rate for this room.
Format (x-alpha/numeric):
nn
Special Format:
Right justified, zero filled
Examples:
14
04
How is null data specified?
This field will be blank.
What does null data indicate?
Minimum length of stay does not apply.
|
|
<MaxLenStay>
|
Numeric
|
2
|
Field Description:
Maximum number of nights allowed to qualify for this rate for this room.
Format (x-alpha/numeric):
nn
Special Format:
Right justified, zero filled
Examples:
07
10
How is null data specified?
This field will be blank.
What does null data indicate?
Maximum length of stay does not apply.
|
|
<AdvBookingPeriod>
|
Numeric
|
3
|
Field Description:
Number of days in advance the booking must be made
Format (x-alpha/numeric):
nnn
Special Format:
Right justified, zero filled
Examples:
090
120
014
How is null data specified?
This field will be blank.
What does null data indicate?
The advance booking period requiement does not apply for this rate.
|
|
<StoredCurrency>
|
Alpha
|
3
|
Field Description:
Currency code for this rate as it is stored in the RoomMaster database.
Format (x-alpha/numeric):
aaa
Special Format:
N/A
Examples:
GBP
EUR
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<StoredDecPos>
|
Numeric
|
1
|
Field Description:
Number of decimals for the stored currency.
Format (x-alpha/numeric):
n
Special Format:
N/A
Examples:
0, 1, 2 or 3
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<AltCurrency>
|
Alpha
|
3
|
Field Description:
Currency code the agent was the display to reflect.
Format (x-alpha/numeric):
aaa
Special Format:
N/A
Examples:
GBP
EUR
How is null data specified?
This field will be blank.
What does null data indicate?
An alternate currency was not requested.
|
|
<AltDecPos>
|
Numeric
|
1
|
Field Description:
Number of decimals for the alternate currency.
Format (x-alpha/numeric):
aaa
Special Format:
N/A
Examples:
GBP
EUR
How is null data specified?
This field will be blank.
What does null data indicate?
An alternate currency was not requested.
|
|
<TaxIncludedInd>
|
Alpha
|
1
|
Field Description:
Taxes are included in the rate.
Format (x-alpha/numeric):
a
Special Format:
Y=Tax included in rate
N=Tax not included in rate
Examples:
Y
N
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
This line is used by automation. Choices = Tax Included, Y, N
|
|
<CommissionAmt>
|
Numeric
|
9
|
Field Description:
Travel agents commission.
Format (x-alpha/numeric):
nnnnnnnnn
Special Format:
Always 6 numbers right of assumed decimal point.
Examples:
000002500
000011000
How is null data specified?
This field will be blank.
What does null data indicate?
If there is a commission, it is a percentage instead of a calculated sum.
|
|
<MealIncludedInd>
|
Alpha
|
1
|
Field Description:
The rate includes meals.
Format (x-alpha/numeric):
a
Special Format:
Y=At least one meal included in rate
N=Meal not included in rate
Examples:
Y
N
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
|
|
+ <HotelDepGuarInfo>
|
HTVQ 1.0
|
|
|
|
+ <DepGuarAry>
|
Array
|
n/a
|
|
|
<DepGuar>
|
Alphanumeric
|
64
|
Field Description:
This is text describing the forms of deposit / guarantee that are acceptable and any other pertinent information.
Format (x-alpha/numeric):
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Special Format:
Left justified, blank filled.
Examples:
Send Deposit To: Property Street Address
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
|
|
|
|
+ <HotelRuleTypeInfo>
|
HTVR 2.0
|
|
|
|
<RuleTypeInd>
|
Alphanumeric
|
2
|
Field Description:
This is a two byte code that identifies the contents in Variable Text Data. Some codes listed below are only applicable to chains that support Complete Pricing or Complete Pricing Plus.
For a full explanation of each code listed below, see the XML Select or XML Web Service help system for the HotelRules transaction. Both tasks listed on the How To page for this transaction link to the Hotel Rule Type Indicator codes.
Format (x-alpha/numeric):
xx
Possible Values(List):
MS, VR, MI, AD, PH, FX, G3, RD, CC, DP, NO, Z0, 0Z, PT, RE, TR, ND, RI, F0, F1, F2, F3, F4, F5, F6, F7, F8, F9, G0, G1, RA, MQ, TS, TA, SC, TB, TX, EX, EC, RC, CR, CM, SM, RV, ML, MP, NR, NC, BT, CL, DG, CT, GA, GD, GO, GH, GM, NF, XC, XO, XT, XX, XF, XM, XE, XD, XB
How is null data specified?
N/A
What does null data indicate?
N/A
|
Len
Structured data only.
Not in XML.
|
Numeric
|
2
|
Field Description:
Length of the text field that follows
Format (n-numeric):
nn
Special Format:
Right justified, zero filled
Note: Maximum values are dependant on Type Indicator, and are listed above.
Possible Values (Range)::
01 - 64
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<Text>
|
Character
|
VL
|
Field Description:
Contents depend on Type Indicator
Format (c-character):
ccccccc....
Examples:
1 King bed with view of the pool
Check In Time: 10:00
AP
How is null data specified?
N/A
What does null data indicate?
N/A
If variable length, specify the maximum allowable length.
64 characters maximum, however exact maximum count will vary by type indicator used.
|
|
|
|
+ <HotelCurrencyInfo>
|
HTVS 1.0
|
|
|
|
<StoredCurrency>
|
Character
|
3
|
Field Description:
This is the currency for this particular property as it is stored in the RoomMaster database.
Format:
aaa
Special Format:
N/A
Examples:
USD
GBP
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<StoredDecPos>
|
Numeric
|
1
|
Field Description:
This is the number of decimal places for the stored currency. This will be 0 to 3.
Format:
n
Special Format:
N/A
Examples:
0
2
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<AltCurrency>
|
Character
|
3
|
Field Description:
This is the currency that the agent requests the display to reflect.
Format (x-alpha/numeric):
aaa
Special Format:
N/A
Examples:
ISK
ILR
How is null data specified?
This will be blanks.
What does null data indicate?
No alternate currency was requested.
|
|
<AltDecPos>
|
Numeric
|
1
|
Field Description:
This is the number of decimal places for the requested currency. This will be 0 to 3.
Format (x-alpha/numeric):
n
Special Format:
N/A
Examples:
1
3
How is null data specified?
This field will be blank.
What does null data indicate?
An alternate currency was not requested.
|
|
<TotNumItems>
|
Numeric
|
4
|
Field Description:
This is the number of HTVR KLRs returned in this Inside Availability response.
Format (x-alpha/numeric):
nnnn
Special Format:
Right justified, zero filled
Examples:
0015
0008
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
|
|
+ <HotelRateSpecificDepGuarInfo>
|
HTVU 1.0
|
|
|
|
<DepGuarInd>
|
Alpha
|
1
|
Field Description:
This field indicates the form of deposit or guarantee that is required.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
D=Deposit Required
G=Guarantee Required
H=Guarantee Required for late arrival
How is null data specified?
This field will be blank.
What does null data indicate?
Neither a deposit or guarantee is required.
|
|
This line is used by automation. Choices = Deposit/Guarantee,D,G,H,blank
|
|
<HoldUntilTm>
|
Numeric
|
4
|
Field Description:
This field states the time the reservation will be held past check in time. (24 hr format)
Format:
nnnn
Special Format:
N/A
Examples:
1800
2100
How is null data specified?
This field will be blanks.
What does null data indicate?
There is not Hold Until time.
|
|
<DepGuarDueInd>
|
Numeric
|
1
|
Field Description:
This field gives meaning to the following "DPST/GUAR Time Due Value" field.
Format (x-alpha/numeric):
n
Special Format:
N/A
Examples:
1=Hours after reservation
2=Days after reservation
3=Hours prior to arrival
4=Days prior to arrival
How is null data specified?
This field will be blank.
What does null data indicate?
No "DPST/GUAR Time Due Value" was specified.
|
|
This line is used by automation. Choices = DPST/GUAR Time Due Indicator,1,2,3,4,blank
|
|
<DepGuarDueValue>
|
Numeric
|
2
|
Field Description:
Number of Hours or Days depending on value of previous field DPST/GUAR Due Indicator
Format (x-alpha/numeric):
nn
Special Format:
Right justified, zero filled.
Examples:
02
14
How is null data specified?
This field will be blank.
What does null data indicate?
No "DPST/GUAR Time Due Value" was specified.
|
|
<DepGuarAmtInd>
|
Alpha
|
1
|
Field Description:
Indicates the format of the next field
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
F=Flat Amount
D=Number of Days of Stay
P=Percent of Full Stay
How is null data specified?
This field will be blank.
What does null data indicate?
The "DPST/GUAR Amount Value" is not specified.
|
|
This line is used by automation. Choices = DPST/GUAR Amount Indicator,F,D,P,blank
|
|
<DepGuarAmtValue>
|
Numeric
|
9
|
Field Description:
Amount of Deposit/Guarantee required.
Format (x-alpha/numeric):
nnnnnnnnn
Special Format:
If F (flat amount), the value is a monetary amount (Currency and # of decimals apply).
If D (# of days), the value is a number. Ex: If the number is 2, then the cost of two days of the specified room rate is the DPST/GUAR amount.
If P (percentage), the value is a percent. Only whole percentage points are available. Ex: If the value is 10, the DPST/GUAR amount is 10 percent of the total cost.
All types are right justified, zero filled.
Examples:
If F, 000005000
If D, 000000001
If P, 000000004
How is null data specified?
This field will be blanks.
What does null data indicate?
No DPST/GUAR Amount is required.
|
|
<DepGuarCurrencyAmt>
|
Numeric
|
9
|
Field Description:
Amount of Deposit/Guarantee required. If an alternate currency was requested, this value will be expressed in that currency.
Format (x-alpha/numeric):
nnnnnnnnn
Special Format:
If F (flat amount), the value is a monetary amount (Alt Currency and # of decimals apply).
If D (# of days), the value is a number. Ex: If the number is 2, then the cost of two days of the specified room rate is the DPST/GUAR amount.
If P (percentage), the value is a percent. Only whole percentage points are available. Ex: If the value is 10, the DPST/GUAR amount is 10 percent of the total cost.
All types are right justified, zero filled.
Examples:
If F, 000001800
If D, 000000002
If P, 000000009
How is null data specified?
This field will be blanks.
What does null data indicate?
No DPST/GUAR Amount is required.
|
|
<DepGuarCurrency>
|
Alpha
|
3
|
Field Description:
The currency code stored for this property in RoomMaster that is to be applied to the Deposit/Guarantee amount.
Format (x-alpha/numeric):
aaa
Special Format:
Only valid for flat amount (DPST/GUAR AMOUNT INDICATOR = F)
Examples:
USD
CAD
How is null data specified?
This field will be blanks.
What does null data indicate?
No DPST/GUAR Amount is required.
|
|
<DepGuarDecPos>
|
Numeric
|
1
|
Field Description:
Number of decimals for the stored currency.
Format (x-alpha/numeric):
n
Special Format:
Only valid for flat amount (DPST/ GUAR AMOUNT INDICATOR = F)
Examples:
0, 1, 2 or 3.
How is null data specified?
This field will be blanks.
What does null data indicate?
No DPST/GUAR Amount is required.
|
|
<DepGuarAltCurrency>
|
Alpha
|
3
|
Field Description:
Alternate currency code requested by the agent.
Format (x-alpha/numeric):
aaa
Special Format:
Only valid for amount (DPST/GUAR Amount indicator = F)
Examples:
GBP
ISK
How is null data specified?
This field will be blanks.
What does null data indicate?
No DPST/GUAR Amount is required.
|
|
<DepGuarAltDecPos>
|
Numeric
|
1
|
Field Description:
Number of decimals for the alternate currency.
Format (x-alpha/numeric):
n
Special Format:
Only valid for flat amount (DPST/ GUAR AMOUNT INDICATOR = F)
Examples:
0, 1, 2 or 3.
How is null data specified?
This field will be blanks.
What does null data indicate?
No DPST/GUAR Amount is required.
|
|
<DepGuarPersonalAddrInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a personal name and / or address is acceptable as a deposit / guarantee.
Format (x-alpha/numeric):
Y=FOP valid
N=FOP invalid
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DepGuarBusinessAddrInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a business name and / or address is acceptable as a deposit / guarantee.
Format (x-alpha/numeric):
Y=FOP valid
N=FOP invalid
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DepGuarAgncyAddrInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a agency name and / or address is acceptable as a deposit / guarantee.
Format (x-alpha/numeric):
Y=FOP valid
N=FOP invalid
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DepGuarAgncyIDInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, an agency ID is acceptable as a deposit / guarantee. An agency ID is an identification number used by some travel agents that are allowed to ticket without having an IATA number. This ID is also refered to as a TID, Traveler's ID.
Format (x-alpha/numeric):
Y=FOP valid
N=FOP invalid
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DepGuarAgncyIATANumInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, an agency IATA number is acceptable as a deposit / guarantee.
Format (x-alpha/numeric):
Y=FOP valid
N=FOP invalid
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DepGuarOvrrideAllowedInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, the agent is allowed to override the guarantee requirement.
Format (x-alpha/numeric):
Y=Override valid
N= Override invalid
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DepGuarClubMbrshpIDInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a Club membership ID is acceptable as a deposit / guarantee.
Format (x-alpha/numeric):
Y=FOP valid
N=FOP invalid
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DepGuarCorpIDInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a corporate ID is acceptable as a deposit / guarantee.
Format (x-alpha/numeric):
Y=FOP valid
N=FOP invalid
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DepGuarReqMetInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, the deposit requirements have been met.
Format (x-alpha/numeric):
Y=FOP valid
N=FOP invalid
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DepGuarMCONumInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, an MCO number is acceptable as a deposit / guarantee.
Format (x-alpha/numeric):
Y=FOP valid
N=FOP invalid
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DepGuarCCInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a credit card is acceptable as a deposit / guarantee.
Format (x-alpha/numeric):
Y=FOP valid
N=FOP invalid
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DepGuarTravVoucherNumInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a travel voucher number is acceptable as a deposit / guarantee.
Format (x-alpha/numeric):
Y=FOP valid
N=FOP invalid
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DepGuarPrepayRelPropInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a prepayment at a related hotel property is acceptable as a deposit / guarantee.
Format (x-alpha/numeric):
Y=FOP valid
N=FOP invalid
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DepGuarCashInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, cash is acceptable as a deposit / guarantee.
Format (x-alpha/numeric):
Y=FOP valid
N=FOP invalid
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DepGuarMoneyOrderInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a money order is acceptable as a deposit / guarantee.
Format (x-alpha/numeric):
Y=FOP valid
N=FOP invalid
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DepGuarPersonalCheckInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a personal check is acceptable as a deposit / guarantee.
Format (x-alpha/numeric):
Y=FOP valid
N=FOP invalid
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DepGuarWireInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a wire is acceptable as a deposit / guarantee.
Format (x-alpha/numeric):
Y=FOP valid
N=FOP invalid
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DepGuarCoCheckInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a company check is acceptable as a deposit / guarantee.
Format (x-alpha/numeric):
Y=FOP valid
N=FOP invalid
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DepGuarTourOrderInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a tour order is acceptable as a deposit / guarantee.
Format (x-alpha/numeric):
Y=FOP valid
N=FOP invalid
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DepGuarTrvlrsCheckInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a travelers check is acceptable as a deposit / guarantee.
Format (x-alpha/numeric):
Y=FOP valid
N=FOP invalid
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DepGuarCertifiedCheckInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a certified check is acceptable as a deposit / guarantee.
Format (x-alpha/numeric):
Y=FOP valid
N=FOP invalid
Special Format:
N/A
Examples:
Y
N
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
<DepGuarSentInd>
|
Alpha
|
1
|
Field Description:
Indicates where DPST/GUAR is to be sent
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
S=Property Street Address
C=Chains Corporate Address
M=Property Mailing Address
How is null data specified?
This field will be blank,
What does null data indicate?
A deposit or guarantee are not required.
|
|
This line is used by automation. Choices = DPST/GUAR Sent to Indicator,S,C,M,blank
|
|
<PropPersonalAddrInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a personal name / address is an acceptable form of payment at the hotel property.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=FOP valid
N=FOP invalid
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N
|
|
<PropBusinessAddrInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a business name / address is an acceptable form of payment at the hotel property.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=FOP valid
N=FOP invalid
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N
|
|
<PropAgncyAddrInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a agency name / address is an acceptable form of payment at the hotel property.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=FOP valid
N=FOP invalid
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N
|
|
<PropAgncyIDInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, an agency ID is an acceptable form of payment at the hotel property.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=FOP valid
N=FOP invalid
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N
|
|
<PropAgncyIATANumInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, an agency IATA number is an acceptable form of payment at the hotel property.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=FOP valid
N=FOP invalid
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N
|
|
<PropGuarOverrideAllowInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, the agent is allowed to override the required form of payment at the hotel property.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=FOP valid
N=FOP invalid
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N
|
|
<PropClubMbrshpIDInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a Club membership ID is an acceptable form of payment at the hotel property.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=FOP valid
N=FOP invalid
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N
|
|
<PropCorporateIDInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a corporate ID is an acceptable form of payment at the hotel property.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=FOP valid
N=FOP invalid
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N
|
|
<PropDepReqMetInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, the deposit requirements have been met.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=FOP valid
N=FOP invalid
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N
|
|
<PropMCONumInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, an MCO number is an acceptable form of payment at the hotel property.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=FOP valid
N=FOP invalid
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N
|
|
<PropCCInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a credit card is an acceptable form of payment at the hotel property.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=FOP valid
N=FOP invalid
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N
|
|
<PropTravVoucherNumInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a travel voucher number is an acceptable form of payment at the hotel property.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=FOP valid
N=FOP invalid
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N
|
|
<PropPrepayRelPropInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a prepayment at a related hotel property is an acceptable form of payment at this hotel property.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=FOP valid
N=FOP invalid
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N
|
|
<PropCashInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a cash is an acceptable form of payment at the hotel property.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=FOP valid
N=FOP invalid
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N
|
|
<PropMoneyOrderInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a money order is an acceptable form of payment at the hotel property.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=FOP valid
N=FOP invalid
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N
|
|
<PropPersonalCheckInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a personal check is an acceptable form of payment at the hotel property.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=FOP valid
N=FOP invalid
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N
|
|
<PropWireInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a wire is an acceptable form of payment at the hotel property.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=FOP valid
N=FOP invalid
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N
|
|
<PropCoCheckInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a company check is an acceptable form of payment at the hotel property.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=FOP valid
N=FOP invalid
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N
|
|
<PropTourOrderInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a tour order is an acceptable form of payment at the hotel property.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=FOP valid
N=FOP invalid
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N
|
|
<PropTrvlrsCheckInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a travelers check is an acceptable form of payment at the hotel property.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=FOP valid
N=FOP invalid
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N
|
|
<PropCertifiedCheckInd>
|
Alpha
|
1
|
Field Description:
If this field is Y, a certified check is an acceptable form of payment at the hotel property.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=FOP valid
N=FOP invalid
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N
|
|
<PropCancelPenInd>
|
Alpha
|
1
|
Field Description:
This field indicates if a cancellation penalty applies.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=Cancellation/Penalty Applies
N=No Cancellation/Penalty
How is null data specified?
This field will be blank
What does null data indicate?
Blank = N.
|
|
|
|
+ <HotelExtraOptionsDetail>
|
HTVX 1.0
|
|
|
|
<OptionInd>
|
Alpha
|
1
|
Field Description:
This field indicates if a room description was provided.
Format (x-alpha/numeric):
a
Special Format:
N/A
Examples:
Y=Room Description Information provided
N=Room Description Information not provided
How is null data specified?
This field will be blank.
What does null data indicate?
Blank = N.
|
|
This line is used by automation. Choices = Extra Option Indicator, Y, N, blank
|
|
<StoredCurrency>
|
Alpha
|
3
|
Field Description:
This is the currency code stored in the RoomMaster database that applies to extra options.
Format (x-alpha/numeric):
aaa
Special Format:
N/A
Examples:
RUB
GBP
How is null data specified?
This field will be blank.
What does null data indicate?
Extra options do not apply.
|
|
<StoredDecPos>
|
Numeric
|
1
|
Field Description:
Number of decimals for the stored currency that applies to extra options.
Format (x-alpha/numeric):
n
Special Format:
N/A
Examples:
0, 1, 2 or 3
How is null data specified?
This field will be blank.
What does null data indicate?
Extra options do not apply.
|
|
<AltCurrency>
|
Alpha
|
3
|
Field Description:
This is the alternate currency code requested by the agent to display the extra option charges in.
Format (x-alpha/numeric):
aaa
Special Format:
N/A
Examples:
RUB
GBP
How is null data specified?
This field will be blank.
What does null data indicate?
Extra options do not apply or an alternate currency was not requested.
|
|
<AltDecPos>
|
Alpha
|
1
|
Field Description:
Number of decimals for the alternate currency.
Format (x-alpha/numeric):
n
Special Format:
N/A
Examples:
0, 1, 2 or 3
How is null data specified?
This field will be blank.
What does null data indicate?
Extra options do not apply or an alternate currency was not requested.
|
|
<ExtraAdultAmt>
|
Numeric
|
9
|
Field Description:
Charge for an extra adult.
Format (x-alpha/numeric):
nnnnnnnnn
Special Format:
Right justified, zero filled.
Examples:
000001000
000001500
How is null data specified?
This field will be blank.
What does null data indicate?
There is no extra adult charge or extra adult option.
|
|
<ExtraChildAmt>
|
Numeric
|
9
|
Field Description:
Charge for an extra child.
Format (x-alpha/numeric):
nnnnnnnnn
Special Format:
Right justified, zero filled.
Examples:
000001000
000001500
How is null data specified?
This field will be blank.
What does null data indicate?
There is no extra child charge or extra child option.
|
|
<NumRollawaysAllowed>
|
Numeric
|
1
|
Field Description:
This is the number of rollaways requested.
Format (x-alpha/numeric):
n
Special Format:
N/A.
Examples:
1
3
How is null data specified?
This field will be blank.
What does null data indicate?
No rollaways were requested.
|
|
<AdultRollawayAmt>
|
Numeric
|
9
|
Field Description:
Charge for an adult size rollaway.
Format (x-alpha/numeric):
nnnnnnnnn
Special Format:
Right justified, zero filled.
Examples:
000001000
000001500
How is null data specified?
This field will be blank.
What does null data indicate?
There is no adult rollaway charge or adult rollaway option.
|
|
<ChildRollawayAmt>
|
Numeric
|
9
|
Field Description:
Charge for a child size rollaway.
Format (x-alpha/numeric):
nnnnnnnnn
Special Format:
Right justified, zero filled.
Examples:
000001000
000000800
How is null data specified?
This field will be blank.
What does null data indicate?
There is no child rollaway charge or child rollaway option.
|
|
<CribAmt>
|
Numeric
|
9
|
Field Description:
Charge for a crib.
Format (x-alpha/numeric):
nnnnnnnnn
Special Format:
Right justified, zero filled.
Examples:
000001200
000000800
How is null data specified?
This field will be blank.
What does null data indicate?
There is no crib charge or crib option.
|
|
<ChildAgeMin>
|
Numeric
|
2
|
Field Description:
Low age to be considered a child.
Format (x-alpha/numeric):
nn
Special Format:
Right justified, zero filled.
Examples:
02
04
How is null data specified?
This field will be blank.
What does null data indicate?
The low age is not specified.
|
|
<ChildAgeMax>
|
Numeric
|
2
|
Field Description:
High age to still be considered a child.
Format (x-alpha/numeric):
nn
Special Format:
Right justified, zero filled.
Examples:
13
10
How is null data specified?
This field will be blank.
What does null data indicate?
The High age is not specified.
|
|
<AltCurrencyExtraAdultAmt>
|
Numeric
|
9
|
Field Description:
Charge for an extra adult expressed in the alternate currency.
Format (x-alpha/numeric):
nnnnnnnnn
Special Format:
Right justified, zero filled.
Examples:
000001000
000001500
How is null data specified?
This field will be blank.
What does null data indicate?
There is no extra adult charge or extra adult option or alternate currency.
|
|
<AltCurrencyExtraChildAmt>
|
Numeric
|
9
|
Field Description:
Charge for an extra child expressed in the alternate currency.
Format (x-alpha/numeric):
nnnnnnnnn
Special Format:
Right justified, zero filled.
Examples:
000001000
000001500
How is null data specified?
This field will be blank.
What does null data indicate?
There is no extra child charge or extra child option or alternate currency.
|
|
<AltCurrencyAdultRollawayAmt>
|
Numeric
|
9
|
Field Description:
Charge for an adult rollaway expressed in the alternate currency.
Format (x-alpha/numeric):
nnnnnnnnn
Special Format:
Right justified, zero filled.
Examples:
000001000
000001500
How is null data specified?
This field will be blank.
What does null data indicate?
There is no adult rollaway charge or adult rollaway option or alternate currency.
|
|
<AltCurrencyChildRollawayAmt>
|
Numeric
|
9
|
Field Description:
Charge for an child rollaway expressed in the alternate currency.
Format (x-alpha/numeric):
nnnnnnnnn
Special Format:
Right justified, zero filled.
Examples:
000001000
000001500
How is null data specified?
This field will be blank.
What does null data indicate?
There is no child rollaway charge or child rollaway option or alternate currency.
|
|
<AltCurrencyCribAmt>
|
Numeric
|
9
|
Field Description:
Charge for a crib expressed in the alternate currency.
Format (x-alpha/numeric):
nnnnnnnnn
Special Format:
Right justified, zero filled.
Examples:
000001000
000001500
How is null data specified?
This field will be blank.
What does null data indicate?
There is no crib charge or crib option or alternate currency.
|
|
|
|
+ <HotelRateSpecificInfo>
|
HTVY 1.0
|
|
|
|
+ <RateAmtAry>
|
Array
|
n/a
|
|
|
+ <RateAmtItem>
|
FieldSet
|
n/a
|
|
|
<RateAmt>
|
Numeric
|
9
|
Field Description:
This field is the per night rate amount for the requested room at the requested property.
Format (x-alpha/numeric):
nnnnnnnnn
Special Format:
Right justified, zero filled.
Examples:
000014000
000008990
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<RateAmtAltCurrency>
|
Numeric
|
9
|
Field Description:
This field is the per night rate amount for the requested room at the requested property expressed in the alternate currency.
Format (x-alpha/numeric):
nnnnnnnnn
Special Format:
Right justified, zero filled.
Examples:
000014000
000008990
How is null data specified?
This field will be blank.
What does null data indicate?
No alternate currency was requested.
|
|
<NumNights>
|
Numeric
|
2
|
Field Description:
This is the total number of nights the guest will be staying at the hotel.
Format (x-alpha/numeric):
nn
Special Format:
Right justified, zero filled.
Examples:
03
14
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<StartDt>
|
Numeric
|
8
|
Field Description:
This is the date of the first night's stay.
Format (x-alpha/numeric):
nnnnnnnn
Special Format:
CCYYMMDD
Examples:
20030723
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
<EndDt>
|
Numeric
|
8
|
Field Description:
This is the date of the last night's stay.
Format (x-alpha/numeric):
nnnnnnnn
Special Format:
CCYYMMDD
Examples:
20030723
How is null data specified?
N/A
What does null data indicate?
N/A
|
|
|
|
|
|
|
|
|
|
|
|