Content Retrieval Response
Element
Level
Attribute
R
OC
Example
Usage
Description
OTA_HotelDescriptiveInfoR
S
R
Only One instance per property.
Version
R
4.000
PrimaryLangI
R
en
Valid values:
en=English
fr=French
es= Spanish de=German
nl=Dutch
it=Italian
zh=Chinese ja=Japanes e pt=Portugu ese
(Brazilian) ru=Russian
Standard ISO identifier.
This attribute defines content language of data returned in this transaction.
If the requested language is not available, by default.
HotelDescriptiveContents
1
R
HotelDescriptiveContent
2
R
BrandCode
R
XX
2 to 6 char
Hotel brand code.
HotelCode
R
1234
Max: 10 char
Hotel property identification code.
HotelName
R
Dallas
Solana
128 Char Max 200 bytes
Hotel property name. Hotel Name is a multi--- lingual attribute.
CurrencyCode
R
USD
Refer to the
Local currency code of
Appendix
for valid codes
property.
Element
Level
Attribute
R
O
C
Example
Usage
Description
TimeZone
O
CST;---06
Time Zone
Time zone and GMT
GMT;+00
– max: 5
offset separated by
PST;---
char
semicolon.
06:30
GMT Offset
TimeZone attribute
– max: 6
contain time zone or
char
GMT offset independently as well.
only GMT offset is provided, it will be preceded by a as the first character the field.
Hotel time zone will the format CST, MST, GMT, etc.
GMT offset should the format of numbers from 1---12 preceded by either a “+” or “---“ (i.e. +12). A single leading zero is also accepted when applicable (i.e. +09). A GMT equal to zero may be loaded as +00. The two time increments are whole hour (i.e. “+11”) and hour increments (i.e. “+11:30”).half
HotelInfo
3
R
HotelStatus
R
Valid enumeratio ns:
• Bookable
• NonBooka le
Defines the bookable status of the property
Enumerated
Will always contain of the values found in the example.
HotelStatusC
R
1
Valid
Only codes of 1, 3, 5,
e
values:
1 = Open
3 =
PreOpening
5 = Test
6 = Inactive
6 are returned.
Element
Level
Attribute
R O
C
Example
Usage
Description
LastUpdated
R
2007---09---
15T14:07: 33Z
Timestamp
TaxID
O
18---25423
16 Char
Max 30 bytes
Hotel Property Tax
Identification Number
WhenBuilt
O
1934
Number
Year property was (or
between 1000 and current year + 10
will be) built.
HotelName
4
O
HotelShortNa
C
Test
30 Char
Short version of the
e
Max: 60
property name
bytes
Refer to HotelName attribute within HotelInfo element for longer name field.
ClosedSeasons
4
O
ClosedSeason
5
R
End
R
2006---02---
Date
End of the hotel
27
seasonal closing.
Start
R
2006---01---
Date
Start of the hotel
27
property seasonal closing.
CategoryCodes
4
R
LocationCategory
5
O
Code
R
2
Refer to the
Location Category
Appendix
for valid OTA codes
(LOC)
CodeDetail
O
Downtow
64 Char
Property Location code
n
Max 128
bytes
Detail. This is meant to provide additional details about the associated LocationCategory Code. CodeDetail is a multi---lingual attribute.
SegmentCategory
5
O
Code
R
4
Refer to the
Segment Category
Appendix
for valid OTA codes
(SEG)
Element
Level
Attribute
R O
C
Example
Usage
Description
HotelCategory
5
R
Code
R
2
Refer to the
Property Class Type
Appendix for valid OTA codes
(PCT)
GuestRoomInfo
5
O
Code
R
2
Refer to the Appendix
for valid OTA codes
Guest Room Info (GRI).
CodeDetail
O
10 rooms
64 Char
Space code detail.
found on floors 1
Max 128
This is meant to
through 5
bytes
additional detail about the associated GuestRoomInfo code.
CodeDetail is a multi--- lingual attribute.
Quantity
R
10
3 Char
Space type count
Indicates the number of units specified by the GRI Code attribute.
Descriptions
4
O
Renovation
5
O
RenovationCo
m
pletionDate
R
2004
4 char
4-digit year the property was last renovated.
Description
5
O
AdditionalDet
O
18
Refer to the
Additional detail code
Code
Appendix
(ADT).
for valid
OTA codes.
Indicates the type of description text to be sent in the associated Text element.
Will default to “2” (Property Description) not sent. Required for all other description types.
ContentID
O
YY1234
Max: 64
Code to link images
char
and media to the property. Must be unique within the property.
Element
Level
Attribute
R O
C
Example
Usage
Description
Text
6
O
2000 Char
Descriptive text associated to the
Max: 2000
corresponding ADT
bytes
codeprovided or if no ADT code is provided, this field should contain property description.
Text is a multi---lingual element.
Language
O
en
2---character
Indicates the language
ISO language code
of the text description being returned.
Position
4
O
Latitude
R
89.99999
Decimal 9,6
Property latitude. The format is a decimal number, maximum length of 9 digits, with a maximum of 6 on the right side of the decimal.
Longitude
R
---
Decimal 9,6
Property longitude.
111.9999
The format is a
number, maximum
length of 9 digits, with a maximum of 6 on the right side of the decimal.
Accuracy
O
Valid
The accuracy level of
enumeratio
latitude and longitude
ns:
Exact
Street
Intersection
Zip
City
State
County
Country
information
Source
O
MapQues
Max: 32
The source from
chars
the latitude and longitude information was obtained.
Element
Level
Attribute
R
OC
Example
Usage
Description
Services
4
R
Service
5
R
BusinessServic
C
2
Refer to
Business Service Type
Code
Appendix
(BUS)
for valid
OTA codes.
Indicates the business services offered by the property.
One and only one of the three code types (HAC, BUS, or MPT) can be present.
If more than one is present, an error will be returned.
Code
C
1
Refer to
Hotel Amenity Code
Appendix
(HAC)
for valid
OTA codes.
Indicates the amenities offered by the
Property will always have at least one Hotel Amenity Code.
Only one of the three code types (HAC, BUS, MPT) will be present in single Service element.
CodeDetail
O
24 Hour
64 Char
Service Code detail
Digital Clock
Max 128
This is meant to provide
bytes
additional detail about the associated Code, BusinessServiceCode or MealPlanCode.
CodeDetail is a multi--- lingual attribute.
Included
O
true
Included in room rate.
false
Indicates whether HAC, BUS or MPT are in room rate, or at an extra charge.
Element
Level
Attribute
R
OC
Example
Usage
Description
MealPlanCode
O
5
Refer to
Meal Plan Type (MPT).
Appendix for valid OTA codes.
Indicates the meal plans offered at the property.
Only one of the three code types (HAC, BUS, MPT) will be present.
ProximityCode
R
1
Refer to
Proximity (PRX).
Appendix
for valid codes.
Indicates the proximity of the service or amenity in relation to property.
OperationSchedules
6
O
OperationSchedule
7
R
OperationTimes
8
O
OperationTime
9
R
Mon
C
true
At least one day of
false
attribute will be "true" OperationTime element is present.
Tue
C
true
At least one day of
false
attribute will be "true" OperationTime element is present.
Weds
C
true
At least one day of
false
attribute will be "true" OperationTime element is present.
Thurs
C
true false
At least one day of week attribute will be "true" if OperationTime element is present.
Fri
C
true
At least one day of week
false
attribute will be "true" if OperationTime element is present.
Sat
C
true
At least one day of week
false
attribute will be "true" if OperationTime element is present.
Sun
C
true
At least one day of week
false
attribute will be "true" if OperationTime element is present.
Element
Level
Attribute
R
O
C
Example
Usage
Description
End
C
08:00:00---
Time
Hours of operation
01:00
Required when Start attributed is populated.
Start
C
18:00:00---
Time
Hours of operation
01:00
Required when End attributed is populated.
Charge
8
O
Amount
R
125.00
Max: 15 char
Charge for Service
ChargeUnit
O
1
Refer to the Appendix
for valid OTA codes
Charge Unit (CHG).
Description
6
O
ContentID
R
HAC001
Max: 64
Code to link images and
char
media to the data type.
Must be unique within the property.
Features
6
O
Feature
7
R
AccessibleCode
C
17
Refer to
Physically Challenged
Appendix for valid
OTA codes
Feature Code (PHY).
Indicates the
accessibility features of the property.
Code attribute under the
element of Service
(HAC) this attribute is present.
Always present when SecurityCode attribute is NOT present.
Only one of the two code types
(AccessibleCode or SecurityCode) will be present per Feature element.
Element
Level
Attribute
R
O
C
Example
Usage
Description
CodeDetail
O
Deadbolt
64 Char
Feature Code detail
located 3 feet from
Max 128
This is meant to provide
bottom offloor.
bytes
additional detail on the associated AccessibleCode or SecurityCode.
CodeDetail is a multi--- lingual attribute.
SecurityCode
C
4
Refer to
Security Feature Code
Appendix
(SEC).
for valid
OTA codes
Indicates the security features of the
Code attribute under element of Service will always be = 80 this attribute is present.
Always present when AccessibleyCode attribute is NOT
present.
Only one of the two types (AccessibleCode SecurityCode) will be present per Feature element.
Languages
4
O
Language
5
R
Language
R
US
Refer to
Language(s) spoken at
Appendix
the property.
for valid codes.
Standard ISO Language identifier.
FacilityInfo
3
R
MeetingRooms
4
O
MeetingRoom
5
R
ID
R
Meet001
Max 32
Char
Unique Identifier for the meeting room
RoomName
O
Chamberl in Room
100 Char
Max: 200 bytes
Meeting Room name
RoomName is a multi--- lingual attribute.
Codes
6
O
Code
7
R
Element
Level
Attribute
R
O
C
Example
Usage
Description
Code
R
1
Refer to
Meeting Room Code
Appendix
(MRC).
for valid
OTA codes
Indicates the meeting room amenities and services.
CodeDetail
O
10.00 per
64 Char
Meeting room code
day
Max: 128
detail
bytes
This is meant to provide additional detail about the associated MRC code.
CodeDetail is a multi--- lingual attribute.
Dimension
6
O
Area
R
6016.00
Decimal 8,2
Meeting Room total area measurement
Height
O
16.00
Decimal
Meeting Room height
Length
O
64.00
Decimal
Meeting Room length
Width
O
94.00
Decimal
Meeting Room width
Units
R
Valid enumerati ons:
• Square Feet
• Square
Meters
• Feet
• Meters
Unit of measure used to describe the dimensions.
AvailableCapacities
6
O
MeetingRoomCapacity
7
R
MeetingRoom FormatCode
R
4
Refer to the Appendix for valid OTA codes
Meeting Room Format Codes (MRF).
Indicates the seating format for the meeting room.
Occupancy
8
R
MaxOccupancy
R
400
4 Char
Maximum capacity for meeting room.
Element
Level
Attribute
R
O
C
Example
Usage
Description
Description
6
O
ContentID
O
MEET001
Max: 64
Char
Code to link images and media to the data type.
Must be unique within the property.
Text
7
O
A really big, great meeting room.
255 Char
Max: 510 bytes
Meeting Room description.
Text is a multi---lingual attribute.
GuestRooms
4
R
Room types from both the hotel partner and DHISCO will be included in the response.
GuestRoom
5
R
ID
R
Superior_
King
Max: 32
Char
Unique Identifier for Guest Room.
The ID of “ALL” is used for information applicable to all guest rooms at the property.
The ID of “SOME” is used for information applicable to some of the guest rooms at the property.
Room types provided by DHISCO are extracted from availability responses and normalized with the correct guest room ID.
Code
O
A1K
Max: 5
Room type code
This is typically the GDS room code.
Element
Level
Attribute
R
O
C
Example
Usage
Description
MaxOccupancy
O
3
Values 1--99
Max number of people (adults and children) allowed in a room. The value must be less than or equal to the
sum of
MaxAdultOccupancy
and
MaxChildOccupancy (if present)
present).
E.g. If a room can accommodate 2 adults and 1 child, or 1 adult and 2 children then MaxOccupancy is 3 and both
MaxAdultOccupancy
and
MaxChildOccupancy are 2.
MaxAdult
Occupancy
C
2
Values 0--99
Maximum number of adults allowed in the room.
If present then
MaxChildOccupancy and MaxOccupancy must also be present. The value cannot be greater than MaxOccupancy
MaxChild
Occupancy
C
2
Values 0--99
Maximum number of
children allowed in the room.
If present then
MaxAdultOccupancy and MaxOccupancy must also be present. The value cannot be greater than MaxOccupancy
TypeRoom
6
O
Only 1 TypeRoom element per
GuestRoom element.
Element
Level
Attribute
R
O
C
Example
Usage
Description
BedTypeCode
O
1
Refer to the
Appendix
for valid OTA codes
Bed type (BED).
Indicates the type of bedding in the associated guest room.
RoomLocation
Code
O
4
Refer to the
Appendix
for valid OTA codes
Room Location Type
(RLT).
Indicates the location of the associated guest room.
RoomViewCod
e
O
9
Refer to the
Appendix
for valid
OTA codes
Room View (RVT).
Indicates the view of the associated guest room.
Name
O
Deluxe
Suite
32 Char
Max 64 bytes
Guest room name.
Name is a multi---lingual attribute.
Amenities
6
R
Amenity
7
R
IncludedInRate
O
true
Indicates if room
ndicator
false
amenity is included in the room rate, or at an extra charge.
RoomAmenityC
R
5
Refer to
Room Amenity Type
ode
Appendix
for valid codes
(RMA).
CodeDetail
O
AM/FM
64 Char
Room amenity code
alarm
detail
clock
Max 128
radio
bytes
This is meant to provide additional detail about the associated
RoomAmenityCode
CodeDetail is a multi--- lingual attribute.
OperationSchedules
8
O
OperationSchedule
9
R
Charge
10
O
Amount
R
10.00
Max: 15
Char
Charge amount for the room amenity.
Element
Level
Attribute
R
O
C
Example
Usage
Description
ChargeUnit
O
1
Refer to the Appendix
for valid
Charge Unit (CHG).
Description
6
O
ContentID
O
ROOM00
Max: 64
Code to link images and
Char
media to the data type.
Must be unique within the property.
Text
7
O
A really great room
255 Char
Max: 510 bytes
Description of the room
Text is a multi---lingual element.
Restaurants
4
O
Restaurant
5
R
ID
R
Rest001
Max: 32
Char
Unique identifier for the restaurant
OfferBreakfast
O
true false
OfferBrunch
O
true false
OfferDinner
O
true false
OfferLunch
O
true false
ProximityCode
O
5
Refer to the Appendix
for valid codes
Proximity (PRX).
RestaurantNa me
O
Suzie’s Steakhou
se
100 Char
Max: 200 bytes
Name of the restaurant RestaurantName is a
multi---lingual attribute.
RestaurantDescription
6
O
Only 1
RestaurantDescription element per Restaurant.
Attire
O
Black tie
64 Char
Max 128 bytes
Description of the restaurant attire.
Attire is a multi---lingual attribute.
ContentID
O
REST001
Max: 64
Char
Code used to link images or media to the restaurant
Element
Level
Attribute
R
O
C
Example
Usage
Description
Text
7
O
A very fancy restaurant
.
255 Char
Max: 510 bytes
Description of the restaurant
Text is a multi---lingual element.
InfoCodes
6
O
Only 1 InfoCodes element per Restaurant element.
InfoCode
7
R
Only 1 InfoCode element per InfoCodes element.
Code
R
Refer to the
Appendix
for valid
Restaurant Category
(RES)
CodeDetail
O
Serving
64 Char
Restaurant category
prime
Max 128
code detail
steak and
bytes
seafood
This is meant to provide additional detail about the associated Restaurant Category (RES) code.
CodeDetail is a multi--- lingual attribute.
CuisineCodes
6
O
Only 1 CuisineCodes element per Restaurant element.
CuisineCode
7
R
Only 1 CuisineCode element per
CuisineCodes element.
Code
R
34
Refer to the Appendix
for valid
Main Cuisine Code (CUI).
SrvcInfoCodes
6
O
SrvcInfoCode
7
R
Code
R
12
Refer to
Restaurant Service Info
Appendix for valid codes
(RSI).
Policies
3
R
Policy
4
R
CancelPolicy
5
O
CancelPenalty
6
R
Element
Level
Attribute
R
O
C
Example
Usage
Description
PolicyCode
R
CXL001
16 Char
Unique identifier for the cancel penalty.
Start
O
2007---12---
Date
Start date for the cancel
01
penalty
End
O
2008---02---
Date
End date for the cancel
28
penalty
Deadline
7
R
AbsoluteDeadli ne
C
14:00:00
+02:00
Time
Cancellation time on of arrival.
Used for day of arrival policies.
Present only when
OffsetTimeUnit,
OffsetUnitMultiplier, and OffsetDropTime attributes are not present.
OffsetUnitMult
iplier
C
1
4 Char
Cancellation time
2
The combination of this attribute with
3
OffsetTimeUnit and OffsetDropTime defines
the cancellation deadline.
Used for policies not associated to day of arrival.
Present only when AbsoulteDeadline is not present.
Element
Level
Attribute
R
O
C
Example
Usage
Description
OffsetTimeUnit
C
Valid enumerati ons:
• Day
• Hour
• Year
• Month
• Week
• Second
• Full
Duration
Cancellation time unit
Used for policies not associated to day of arrival.
The combination of this attribute with OffsetUnitMultiplier OffsetDropTime defines
the cancellation deadline.
Present only when AbsoluteDeadline is not present.
OffsetDropTim
e
C
Valid enumerati ons:
• BeforeArri val
• AfterBook ing
Applicability of the cancellation time period
The combination of this attribute with OffsetUnitMultiplier and
OffsetTimeUnit defines the cancellation deadline.
Used for policies not associated to day of arrival.
Enumerated attribute. Always contains one of the values found in the example.
Present only when AbsoulteDeadline is not present.
AmountPercent
7
R
Amount
C
50.00
Decimal
12,3
Cancel penalty amount as monetary value
Present only when
Percent or NmbrOfNights attributes are NOT present.
Element
Level
Attribute
R
O
C
Example
Usage
Description
TaxInclusive
O
true false
Identifies if tax is included in cancel policy.
NmbrOfNights
C
1
4 Char
Cancel penalty amount as number of nights
Present only when Amount or Percent attributes are NOT present.
Percent
C
20
3 Char
Cancel penalty amount as a percentage of stay
Present only when
Amount or
NmbrOfNights attributes are NOT present.
PenaltyDescription
7
O
Text
8
O
Loss of deposit if not cancelled within deadline.
255 Char
Max: 510 bytes
Cancel penalty description
Text is a multi---lingual element.
GuaranteePaymentPolicy
5
O
There can be multiple GuaranteePaymentPolic y elements per property, but only one for each combination of Type and
PaymentCode.
GuaranteePayment
6
R
GuaranteeCode
R
Guarantee
Indicates whether the
DepositPoli
element contains
cy
guarantee policy or
MethodOfP
aymentPoli cy
CreditCard olicy
payment method information.
Element
Level
Attribute
R
O
C
Example
Usage
Description
GuaranteeType
R
Deposit
Identifies the policy as
Guarantee
Required
Guarantee, Deposit or Hold Time.
None
Required only when
GuaranteeCode =
GuaranteeDepositPolic
y.
PaymentCode
C
3
Refer to the
Payment Type (PMT).
Appendix
for valid codes
Required only when
GuaranteeCode = MethodOfPaymentPolic y
Type
R
RequiredPa
Transaction Type for
yment
GuaranteeP
olicy
AcceptedPa
ymentForm
s
which the payment method applies RequiredPayment = Deposit
GuranteePolicy =
Guarantee
AcceptedPaymentForm s = Settlement Required only when
GuaranteeCode = MethodOfPaymentPoli
cy
HoldTime
O
16:00:00---
Time
Latest reservation hold
05:00
time
Required when
GuaranteeType = None.
Mon
C
true false
Day of the Week that they Guarantee
Payment Policy applies.
Tue
C
true false
Day of the Week that they Guarantee
Payment Policy applies.
Weds
C
true false
Day of the Week that they Guarantee
Payment Policy applies.
Thur
C
true false
Day of the Week that they Guarantee
Payment Policy applies.
Fri
C
true false
Day of the Week that they Guarantee
Payment Policy applies.
Sat
C
true false
Day of the Week that they Guarantee
Payment Policy applies.
Element
Level
Attribute
R
O
C
Example
Usage
Description
Sun
C
true false
Day of the Week that they Guarantee
Payment Policy applies.
Start
R
2007---12---
01Z
Date
Start date for the guarantee or deposit or hold time policy.
End
R
2008---02---
28Z
Date
End date for the guarantee or deposit or hold time policy.
AcceptedPayments
7
C
Element present when PaymentCode = 5 (Credit Card).
AcceptedPayment
8
R
PaymentCard
9
C
CardCode
R
MC
Refer to the
Appendix for the valid codes.
Two letter code of the credit card issuer.
Description
7
C
Element required when GuaranteeCode =
GuaranteeDepositPolicy.
Text
8
R
Deposit of 1 night
room and
tax charged to credit card at time of booking.
255 Char
Max: 510 bytes
Policy description
Text is a multi---lingual element.
CheckoutCharges
5
O
CheckoutCharge
6
R
Amount
C
50.00
Max 15
Early check---out charge
Char
amount as a monetary value
Present only when
Percent and NmbrOfNights are NOT present.
Element
Level
Attribute
R
O
C
Example
Usage
Description
Percent
C
20
Decimal
Early check---out charge
(6,2)
a percentage of stay
Present only when
Amount and
NmbrOfNights
Are NOT present.
NmbrOfNights
C
2
Max 2 Char
Early check---out charge as number of nights
Present only when Amount and Percent attributes are NOT present.
Description
7
O
Text
8
O
Please check with front desk for further details.
255 Char
Max: 510 bytes
Early check---out policy description text
Text is a multi---lingual element.
PolicyInfo
5
R
CheckInTime
R
16:00:00
+
Time
CheckOutTime
R
12:00:00
+
Time
KidsStayFree
R
true false
UsualStayFree
C
12
Max 2
Age limit for child to
CutoffAge
free
Only present when
KidsStayFree = true.
UsualStayFree
ChildPerAdult
O
2
Max 2 Char
Number of free children allowed in a room.
Note: the
ChildPolicyExtended TPA extension can be used to define more complicated policies
Description
6
O
Element
Level
Attribute
R
O C
Example
Usage
Description
Element
Level
Attribute
R
O
C
Example
Usage
Description
Text
7
R
Descripti on of the
property’ s child policy.
255 Char
Max: 510 bytes
Children’s Policy description
Text is a multi---lingual element.
TaxPolicies
5
R
TaxPolicy
6
R
Code
R
4
Refer to
Fee Tax Type (FTT).
Appendix
for valid codes
Indicates the type of tax or fee.
Percent
C
15
Max: 3 Char
Taxes & Fees type
indicator
Present only when Amount attribute is not present.
Amount
C
20.00
Max 15
Taxes & Fees amount
char
Present only when Percent attribute is not present.
ChargeUnit
R
1
Refer to the
Appendix
for valid
Charge Type (CHG)
EffectiveDate
C
2011---01---
Date
These dates specify
01
when the tax policy is active.
The start and end dates are optional, but if one specified then so must the other. For open--- ended taxes/fees, an arbitrary end date in future should be
specified, such as 2099--- 12---31
It is valid for the start date to be in the future or the end date to be in the past. The end date cannot be before the start date.
ExpiryDate
C
2015---12---
31
Date
Element
Level
Attribute
R
O
C
Example
Usage
Description
TaxDescription
7
O
Only 1 element allowed per Tax Policy. A tax/fee description is optional and can be used to provide additional information. However, the description is required when there is more than one TaxPolicy with the same Code and ChargeUnit are active at the same time. In this scenario, each of the similar tax policies must include a description that will allow a consumer to distinguish between them. Tax policies are active at the same time if they have overlapping effective dates or if one or more does not have effective dates specified (i.e. it is always active).
Text
8
R
Tax is applied to all fees.
255 Char
Max: 510 bytes
Tax policy description text
Text is a multi---lingual element.
PetsPolicies
5
O
PetsAllowedCo de
O
Valid enumerati ons:
• Pets
Allowed
• Pets Not Allowed
Indicates at a high level whether or not pets are allowed.
For more detailed Pet Policy information, see element Pets Policy element.
PetsPolicy
6
O
PetsPolicyCode
R
5
Refer to the
Pet Policy (PET).
for valid codes
Indicates the types of pets accepted.
Description
7
R
Element
Level
Attribute
R
O
C
Example
Usage
Description
Text
8
O
Pets allowed under 15 lbs.
255 Char
Max: 510 bytes
Description of the pet policy.
Text is a multi---lingual element.
CommissionPolicy
5
O
Description
6
O
Text
7
O
10% standard commissi o n paid to IATA
members
255 Char
Max: 510 bytes
Description of the
commission policy
Text is a multi---lingual element.
PaymentCompany
6
O
Name
R
Valid values:
H = Onyx Commissio n
Processing
(previously HCC)
C = NPC W
= WPS
P = Perot Systems
O = Other
N = None
Automated commission payment service used by the property
AreaInfo
3
R
Attractions
4
R
Attraction
5
R
AttractionCate goryCode
R
9
Refer to the
Appendix
for valid codes
Attraction Category Code (ACC).
Same
AttractionCategoryCod e value may occur more than once as long as ID attribute value is unique.
AttractionNam
O
Dallas---Ft.
64 Char
The name of the
e
Worth
Internatio nal
Max: 128 bytes
attraction
AttractionName is a
Airport
multi---lingual attribute.
Element
Level
Attribute
R
O
C
Example
Usage
Description
Code
C
DFW
3 Char
Industry recognized airport code
Attribute is ONLY present when
AttractionCategoryCode = Airport.
ID
R
ACC001
Max: 32
Char
Unique identifier for
Attraction
Contact
6
O
Only 1 Contact element per Attraction element.
URLs
7
O
Description
6
O
ContentID
O
AREA002
Max: 64
Char
Code used to link images or media to the attraction information.
Text
7
O
Internatio
nal airport servicing the Dallas & Ft. Worth area with over 2,000
flights per day.
255 Char
Max: 510 bytes
Attraction description
Text is a multi---lingual element.
RefPoints
6
O
RefPoint
7
R
Direction
O
Valid
Defines the cardinal
enumerati
direction from the
ns:
• N
• NE
• NW
• S
• SE
• SW
• E
• W
attraction to the hotel
Element
Level
Attribute
R
O
C
Example
Usage
Description
Distance
R
12
Decimal 5,2
Distance to/from the attraction.
DistanceUnitNa me
R
Valid enumerati ons:
• Mile
• Km
• Block
Unit of measure for distance
CityCode
O
DAL FTW
MIA
Max: 3 Char
City Codes.
PrimaryIndicat or
O
true false
Identifies the attraction as the primary within the attraction category
Only permitted once per each attraction category.
Transportations
8
O
Transportation
9
R
Transportation
Code
R
12
Refer to the
Appendix
for valid codes
Transportation Code (TRP).
Indicates the transportation types available between attraction and property.
Included
O
O
false
Boolean
Amount
O
10.00
Max 15 char
Cost of transportation to/from Reference
ChargeUnit
O
O
CHG code list
Specifies what the Amount applies to – e.g. one-way, round-trip etc.
Descriptions
10
O
Description
11
R
Required when
Descriptions Element is present.
Element
Level
Attribute
R
O
C
Example
Usage
Description
Text
12
O
Most car rental
compani es have counters at OHare Internati onal Airport.
1024 Char
Max: 2000 bytes
Transportation description
Required when
Description element is present.
Only 1 Element allowed
per
AttractionCategoryCode /ID combination within the Attraction Element. If more than one is present, an error will be returned.
Text is a multi-lingual element.
OperationSchedules
10
11
O
Specifies the hours of operation by days of week for the transportation method.
OperationSchedule
11
R
Required when OperationSchedules is present.
OperationTimes
12
R
Required when OperationSchedule is present.
OperationTime
13
R
Multiple OperationTime elements can be present as long as they are not effective for the same period/days of week.
At least one of the days of week attributes (e.g. Mon, Tue) must be set to true.
Mon
C
Tue
C
Weds
C
Thur
C
Fri
C
Sat
C
Sun
C
Start
C
08:00:00
End
C
23:00:00
Descriptions
8
O
Only 1 element allowed per Attraction.
Description
9
R
Required when
Descriptions Element is present.
Element
Level
Attribute
R
O
C
Example
Usage
Description
Text
10
O
30 west to
exit 282,
Main
Street.
Continue straight through light, and the hotel is located 1/4 mile ahead on the left.
1,024 Char
Max: 2,000 bytes
Directions description
Required when
Description element is present.
Only 1 Element allowed per
AttractionCategoryCode / ID combination within the Attraction Element. If more than one is present, an error will be returned.
Text is a multi-lingual element.
Recreations
4
O
Recreation
5
R
Required when
Recreations element is present.
CodeDetail
O
Please
64 Char
Recreation Service Type
contact
front
deskfor tee times.
Max 128
bytes
code detail
This is meant to provide additional detail about the associated RST code CodeDetail is a multi--- lingual attribute.
Code
R
34
Refer to
Recreation Service Type
Appendix
for valid codes
(RST).
ProximityCode
O
6
Refer to Appendix
for valid codes
Proximity Table (PRX).
Included
O
true
Indicates if the
false
recreation is included with the room rate, or there is an extra charge.
Description
6
O
ContentID
O
POOL001
Max: 64
Char
Code used to link images or media to the attraction information
Text
7
O
This is a great recreation
255 Char
Max: 510 bytes
Recreation description
Text is a multi---lingual element.
RecreationDetails
6
O
Element
Level
Attribute
R
O
C
Example
Usage
Description
RecreationDetail
7
R
Code
R
3
Refer to
Recreation Service
Appendix for valid codes
Code (REC).
CodeDetail
O
18
64 Char
Max 128 bytes
Recreation service detail detail
This is meant to provide additional detail about the associated REC code.
CodeDetail is a multi--- lingual attribute.
AffiliationInfo
3
O
Awards
4
R
Award
5
R
Date
O
2004---10---
Date
Reflects the date the
15
rating or award was given.
Provider
R
Dallas
100 Char
Name of provider who
Chamber
of
Commerc
e
Max: 200 bytes
gave the award or rating.
Required for Award element.
Provider value must be unique.
Rating
R
4 Stars
100 Char
Hotel rating or award
Max: 200
given.
bytes
Example: “3 Stars – Magazine, 2 Circles --- Circle Magazine”
Only 1 Rating attribute per unique Provider.
Rating is a multi---lingual attribute.
LoyalPrograms
4
C
Required when
AffiliationInfo element is present and Awards element is not present.
Element
Level
Attribute
R
O
C
Example
Usage
Description
LoyalProgram
5
R
Can repeat more than once if the property participates in more than one program (but the ProgramName must be unique).
ProgramName
O
Loyal
Loyal programs name,
programs name, e.g. “La Quinta
Returns”
e.g. “La Quinta
HotelLevel
O
16 Char
The level/tier that the
Max 32
hotel participates in the
bytes
loyalty program. This may affect the number of ‘points’ received for stay or the number of points required to redeem free nights. Examples:
“B” (level B)
“2” (Level 2)
“Tier 2”
MultimediaObjects
3
O
MultimediaObject
4
R
ContentCaptio n
R
This is a great pool.
50 Char
Max 100 bytes
Image caption
ContentData
R
A
Valid values:
A=Still
Images
B=Streami n g Video
C= Virtual Tour
D= Flash
Web Show
E= Digital Brochure
Type of media
Element
Level
Attribute
R
O
C
Example
Usage
Description
ContentID
O
Pool001
Max: 64
Links the image file to
Char
specific property data.
This ContentID should correspond to a
ContentID within one of the other elements for the property.
Description
O
255 Char
Max 510 bytes
Image description
FileName
R
Poolfront
. jpg
Max 64 char
Image file name
ParagraphNum
R
1 , 2, 3,
Max 3 Char
Image display order
ber
etc.
number.
ParagraphNumber
value of 1 indicates the first image to be displayed.
PictureCategor y Code
R
1
Refer to the
Appendix
for valid codes
Picture Category Code
(PIC).
The same
PictureCategoryCode may be reused as long
as either the corresponding
ParagraphNumber or
ContentID are unique.
URL
5
R
http://w ww.icepo rtal.com/ brochure s/media/ show.asp x?brochu reid=ICE3 5878&did =3073&m type=307 3&type=p ic&lang=e n&publici d=5743 995&resiz ing=XL
Media Link
Refer to Appendix C for further details on accessing images using the URL.
ContactInfos
3
R
ContactInfo
4
R
Element
Level
Attribute
R
O
C
Example
Usage
Description
Addresses
5
R
Address
6
R
UseType
R
7
Refer to the Appendix for valid codes
Address Use Type (AUT).
AddressLine
7
R
1530
N. Central Expressw
a y
255 Char
Max: 510 bytes
Hotel property address. Up to 5 AddressLine elements may be returned per property. AddressLine is a multi--- lingual attribute.
CityName
7
R
Dallas
64 Char
Max 128 bytes
Hotel property city
CityName is a multi--- lingual attribute.
PostalCode
7
O G
75305
Max: 16
Char
Hotel property postal code
County
7
O
G
Dallas
32 Char
Max 64 bytes
Hotel property county
County is a multi---lingual attribute.
StateProv
7
C
Only present when Country Code is US or CA.
StateCode
R
TX
Refer to the
Appendix for valid codes
Hotel property state/province code.
CountryName
7
R
Code
R
US
Refer to the Appendix
for valid codes
Hotel property country code.
Phones
5
R
Phone
6
R
PhoneLocation
Type
R
2
Refer to the Appendix for valid codes
Phone Location Type (PLT).
Element
Level
Attribute
R
O
C
Example
Usage
Description
PhoneTechTyp
e
R
5
Valid values: 1 =
Voice 3 =
Fax
6 = TTY
7 = Telex
CountryAccess
Code
C
011
See appendix for valid codes.
Always present when
PhoneLocationType = 4.
AreaCityCode
O
972
Max: 8 Char
Hotel property area code
PhoneNumber
R
555---1212
Max: 32
Char
Hotel property number
Emails
5
O
6
R
joebob@
myhotel.c om
Max: 128 Char
Hotel property Internet e---mail ID.
EmailType
R
5
Valid values:
5 =
Property
7 = Reservati on Office
Indicates the type of email address.
TPA_Extensions
3
O
TPA_Extension
4
R
USWInfo
5
O
Chain
R
ZZ
2 to 3 Char
UltraSwitch Chain Code
PID
R
1234
Max: 10
Char
UltraSwitch Property ID
HotelFacts
5
O
HotelFact
6
R
Fact
R
Pool is
180 Char
Fact about the hotel.
closed
th
June 12 th
– 25 .
Max: 360 bytes
Fact is a multi---lingual attribute.
Start
R
2006---01---
Date
First date when fact
27
should be displayed.
End
R
2006---06---
Date
Last date when fact
26
should be displayed.
GuranteePaymentExtende d
5
O
Element
Level
Attribute
R
O
C
Example
Usage
Description
LateArrivalsAllo wed
R
true false
Defines if late arrivals are allowed at the property.
Mon
C
true false
Day of Week used to identify the guarantee or deposit or hold time policy to which the late arrival policy applies.
Tue
C
true
Day of the Week used
false
identify the guarantee deposit or hold time policy to which the arrival policy applies
Weds
C
true
Day of the Week used
false
identify the guarantee deposit or hold time policy to which the arrival policy applies
Thur
C
true
Day of the Week used to identify the guarantee or deposit or hold time policy to which the late arrival policy applies
Fri
C
true
Day of the Week used
false
identify the guarantee deposit or hold time policy to which the arrival policy applies
Sat
C
true
Day of the Week used
false
identify the guarantee deposit or hold time policy to which the arrival policy applies
Sun
C
true
Day of the Week used
false
identify the guarantee deposit or hold time policy to which the arrival policy applies
Start
R
2007---12---
Date
Start date used to
01Z
identify the guarantee deposit or hold time policy to which the arrival policy applies
Element
Level
Attribute
R
O
C
Example
Usage
Description
End
R
2008---02---
28Z
Date
End date used to identify the guarantee or deposit or hold time policy to which the late arrival policy applies
ChildPolicyExtended
5
O
Used to extend the
child policy information defined in:
HotelDescriptiveConte nt/Policies/Policy/
PolicyInfo
FreeChildCount
O
1
Integer
Number of free children for each
RoomCompanion
Count
MaxFreeChildC ount
O
2
Integer
Maximum number of
free children. If not present then it is
unlimited (up to the maximum room/child occupancy for the room).
RoomCompanio nCount
O
1
Integer
Required number of accompanying guests in the room for the free child policy to apply.
RoomCompanio nType
O
Adult
Values:
“PayingGue
st” or “Adult”
Required number of accompanying guests in the room for the free child policy to apply.
GDS_Info
3
O
GDS_Codes
4
R
GDS_Code
5
O
ChainCode
R
ZZ
2 Char
GDS Chain Code
GDS_PropertyC ode
R
12345
10 Char
GDS Property ID
Element
Level
Attribute
R O
C
Example
Usage
Description
GDS_Name
R
Amadeus
Max: 15
Name of the GDS
ApolloGal
byte
System.
leo
Sabre
Enumerated
Worldspa
The values are found
n
the example.