Data mapping of elements
Property additions are denoted by an Action of “Add” in the SOAP header. When a property is being added to the HCD, it must contain a minimum required set of data elements in order to be considered valid. The following tables describe the required, optional, and conditional data requirements. If the resulting property record does not contain the minimum set of data, an error will be returned to the client, and the property information will not be added.
Property updates are denoted by an Action of “Update” in the SOAP header. When a property is being updated in the HCD, the resulting property record must contain a minimum required set of data elements in order to be considered valid. If the resulting property record does not contain this minimum set of data, an error will be returned to the client, and the property information will not be updated.
Property information can be logically broken down into several categories, each of which can be updated independently. The following sections define the message structures required to update these categories.
Basic property information
Although OpenTravel allows unlimited occurrences of each element within the OTA_HotelDescriptiveContentNotifRQ message, ENTERPRISE CONNECTIVITY has elected to set limits for many of these elements. Unless specified under the Usage column below, ENTERPRISE CONNECTIVITY only allows one instance of each element per property message.
Note that Level 1 & 2 elements and attributes are only addressed in this section and will not be repeated in subsequent sections.
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
OTA_HotelDescriptiveCon tentNotifRQ
R
Only 1 element allowed per Property message.
Version
R
4.000
Version 4.000 should always be used.
Required for
OTA_HotelDescriptiveCo ntentNotifRQ element.
PrimaryLangID
R
C
EN
Refer to the Appendix B for valid codes
Standard ISO Language identifier.
This attribute defines the language encoding that will be used in the text fields of this transaction.
GDS Note: Only English based property information will be distributed to the GDSs.
HotelDescriptiveContents
1
R
Required when
OTA_HotelDescriptiveCo ntentNotifRQ element is present.
Only 1 element allowed per Property message.
HotelDescriptiveContent
2
R
Required when
OTA_HotelDescriptiveCo ntents element is present.
Only 1 element allowed per Property message.
UnitOfMeasur eCode
C
O
Refer to “HCD
OTA
Supported Codes” spreadsheet for valid codes. Only codes 1, 2 & 10 will be accepted in this context.
Unit of Measure (UOM).
Only codes of 1, 2 and 10 are accepted. All others codes will generate an error.
When provided, this attribute will apply for all Attractions.
Only one code per property allowed. If more than one provided in same message will generate an error.
BrandCode
R
XX
2 to 6 Char
Hotel brand code.
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
Required for
OTA_HotelDescriptiveCo ntent element.
HotelCode
R
YY1234
10 Char
Hotel property identification code.
Required for
OTA_HotelDescriptiveCo ntent element.
CurrencyCode
C
O
USD
Refer to the Appendix for valid codes
Local currency code of property.
Only Required when action code is add or Overwrite = true.
TimeZone
O
O
CST;-06
GMT;+00
PST;-06:30
Time Zone –
Max: 5 Char
GMT Offset –
Max: 6 Char
Time zone and GMT offset separated by semicolon.
Hotel time zone must have the format CST, MST, GMT, etc.
GMT offset should follow 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 acceptable time increments are whole hour (i.e. “+11”) and half hour increments (i.e.
“+11:30”).
HotelName
R
Test Hotel & Resort
128 Char
Max: 200 bytes
Hotel property name.
Hotel Name is a multi- lingual attribute.
Only Required when action code is add, Overwrite = true, or when adding an additional language.
Overwrite
O
true false
Defines if the property data is to be updated or overwritten with data sent in the message. If “true”, all existing data
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
will be deleted and only the data contained within the update message will be inserted in its place.
If not specified, false is assumed.
HotelInfo
3
C
Element required when action code is Add or Overwrite = true
Only 1 element allowed per Property message.
WhenBuilt
O
R
1934
Number between 1000 and current year + 10
Year property was (or will be) built
HotelStatus
C
O
Bookable
NonBookable
Defines the bookable
status of the property
Enumerated attributed. Must use one of the values found in the example.
Only Required when action code is add or Overwrite = true.
HotelStatusCo de
C
C
Refer to “HCD
OTA
Supported Codes” spreadsheet for valid codes. Only codes 1, 3, 5 & 6 will be accepted in this context.
Hotel Status (HST).
Only codes of 1, 3, 5, and 6 will be accepted.
Only Required when action code is add or Overwrite = true.
GDS Rqmt: Only properties found in a status of 1 will be delivered to the GDSs.
TaxID
O
O
25423
16 Char
Max: 30 bytes
Hotel Property Tax
Identification Number
Removal
O
true false
If not specified, false is assumed.
HotelName
4
O
R
Element required when property’s information is delivered to the GDSs.
Only 1 element allowed
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
per Property message.
HotelShortNa me
O
R
Test Htl & Rst
30 Char
Max: 60 bytes
Used to populate the GDS property name and GDS short name.
Only 1 element allowed per Property message.
ClosedSeasons
4
O
Only 1 element allowed per Property message.
ClosedSeason
5
R
Required when
ClosedSeasons Element is present
Start
R
2006-01-27
Date
Start of the hotel property seasonal closings.
Required for
ClosedSeason Element.
End
R
2006-02-27
Date
End of the hotel property seasonal closings.
Required for
ClosedSeason Element.
CategoryCodes
4
C
Only Required when action code is add or Overwrite = true.
Only 1 element allowed per Property message.
LocationCategory
5
C
Only Required when action code is add or Overwrite = true.
Code
R
R
Refer to the
“HCD OTA
Supported Codes” spreadsheet for valid codes
Location Category Code (LOC).
Required for LocationCategory element.
CodeDetail
O
Downtown
64 Char
Max: 128 bytes
Property Location code detail
This is meant to provide additional details about the associated LocationCategory.
CodeDetail is a multi- lingual attribute.
Removal
O
true false
If not specified, false is assumed.
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
SegmentCategory
5
C
Only Required when action code is add or Overwrite = true.
Code
R
R
Refer to the
“HCD OTA
Supported Codes” spreadsheet for valid codes
Segment Category Code
(SEG)
Required for SegmentCategory element.
Removal
O
true false
If not specified, false is assumed.
HotelCategory
5
C
Only Required when action code is add or Overwrite = true.
Code
R
O
Refer to the
“HCD OTA
Supported Codes” spreadsheet for valid codes
Property Class Type
(PCT)
Required for
HotelCategory element.
Removal
O
true false
If not specified, false is assumed.
GuestRoomInfo
5
O
Code
R
R
Refer to the
“HCD OTA
Supported Codes” spreadsheet for valid codes
Guest Room Info (GRI) codes.
Required for GuestRoomInfo Element.
GDS Note: GRI codes of 5 and 12 are required for the GDSs.
CodeDetail
O
10 rooms found on floors 1 through 5
64 Char
Max: 128 bytes
Space code detail.
This is meant to provide additional detail about the associated GuestRoomInfo code.
CodeDetail is a multi- lingual attribute.
Removal
O
true false
If not specified, false is assumed.
Quantity
C
O
10
3 Char
Space type count
Only Required when action code is add or
Overwrite = true
Descriptions
4
O
Only 1 element allowed per Property message.
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
Renovation
5
O
Only 1 element allowed per Property message.
RenovationCo mpletionDate
R
O
2004
4 Char
4-digit year the property was last renovated.
Description
5
C
Only Required when action code is add or Overwrite = true
AdditionalDeta ilCode
C
18
Refer to the
“HCD OTA
Supported Codes” spreadsheet for valid codes
Additional Detail Type Code (ADT).
Indicates the type of description to be provided in the corresponding Description/Text.
Defaults to “2” (Property Description) if not sent. Required for all other description types.
Removal
O
true false
If not specified, false is assumed.
Text
6
R
O
2,000 Char
Max: 8,000 bytes
Descriptive text associated to the corresponding ADT code provided or if no ADT code is provided, this field should contain the property description.
Only one allowed per AdditionalDetailCode type..
Text is a multi-lingual element.
Position
4
O
Only 1 element allowed per Property message.
Latitude
R
O
89.100391
Decimal 9,6
Property latitude.
Longitude
R
O
-111.99999
Decimal 9,6
Property longitude.
Accuracy
O
Valid enumerations:
• Exact
• Street
• Intersection
• Zip
Accuracy level of the latitude and longitude coordinates
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
• City
• State
• County
• Country
Source
O
Navteq
Max 32 chars
Source of the property latitude and longitude coordinates
Services
4
C
Only Required when action code is add or Overwrite = true.
Only 1 element allowed per Property message.
Service
5
R
Required when Services is present.
Included
O
R
true false
Included in room rate, or at an extra charge.
Value will be defaulted to “false” if attribute is not sent in message.
Code
C
R
Refer to the
“HCD OTA
Supported Codes” spreadsheet for valid codes.
Hotel Amenity Code (HAC).
Property must be associated to at least one Hotel Amenity Code.
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.
BusinessServic eCode
C
R
Refer to the
“HCD OTA
Supported Codes” spreadsheet for valid codes.
Business Service Type
(BUS)
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.
CodeDetail
O
24 Hour
Digital Clock
64 Char
Max: 128 bytes
Service Code detail
This is meant to provide additional detail about the associated Code, BusinessServiceCode or MealPlanCode.
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
CodeDetail is a multi- lingual attribute.
Removal
O
true false
Triggers removal of this service.
If not specified, false is assumed.
ProximityCode
C
R
Refer to the
“HCD OTA
Supported Codes” spreadsheet for valid codes.
Proximity (PRX).
Only Required when action code is add or
Overwrite = true
ExistsCode
C
Refer to the
“HCD OTA
Supported Codes” spreadsheet for valid codes.
Option Type Code (OTC).
Information under
Service element will only be added when code = 1 or attribute is not present.
MealPlanCode
C
R
Refer to the
“HCD OTA
Supported Codes” spreadsheet for valid codes.
Meal Plan Type (MPT). 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.
OperationSchedules
6
O
Only 1 element allowed per Service
OperationSchedule
7
R
Required when OperationSchedules is present.
Only 1 element allowed per Service
OperationTimes
8
O
Required when OperationSchedule is present.
Only 1 element allowed per Service
OperationTime
9
R
At least one day of week attributes must be
"true"
Required when OperationTimes is present.
Mon
C
O
true
Required when Tue,
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
false
Weds, Thur, Fri, Sat, or Sun attribute is NOT populated.
Tue
C
O
true false
Required when Mon,
Weds, Thur, Fri, Sat, or Sun attribute is NOT populated.
Weds
C
O
true false
Required when Mon,
Tue, Thur, Fri, Sat, or Sun attribute is NOT populated.
Thur
C
O
true false
Required when Mon,
Tue, Weds, Fri, Sat, or Sun attribute is NOT populated.
Fri
C
O
true false
Required when Mon,
Tue, Weds, Thur, Sat, or Sun attribute is NOT populated.
Sat
C
O
true false
Required when Mon,
Tue, Weds, Thur, Fri, or Sun attribute is NOT populated.
Sun
C
O
true false
Required when Mon,
Tue, Weds, Thur, Fri, or Sat attribute is NOT populated.
Start
C
O
08:00:00
Time
Hours of operation
Required when End attributed is populated.
End
C
O
23:00:00
Time
Hours of operation
Required when Start attributed is populated.
Charge
8
O
Only 1 element allowed per Operation Time
Amount
R
O
125.00
Decimal 12,3
Amenity charge / fee
Required for Charge Element.
ChargeUnit
O
Refer to the
“HCD OTA
Supported Codes” spreadsheet for valid codes.
Charge Unit (CHG).
Description
6
O
Only 1 element allowed per Service
ContentID
O
HAC001
64 Char
Image code
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
Required for Description Element.
Features
6
O
Only 1 element allowed per Property message.
Feature
7
R
Required when Features Element is present.
CodeDetail
O
Deadbolt located 3 feet from bottom of floor.
64 Char
Max: 128 bytes
Feature Code detail
This is meant to provide additional detail on the associated AccessibleCode or SecurityCode.
CodeDetail is a multi- lingual attribute.
ExistsCode
C
Refer to the
“HCD OTA
Supported Codes” spreadsheet for valid codes.
Option Type Code (OTC).
Information under Feature element will only be added when code = 1 or attribute is not present.
Removal
O
true false
If not specified, false is assumed.
AccessibleCod e
C
O
Refer to the
“HCD OTA
Supported Codes” spreadsheet for valid codes
Physically Challenged Feature Code (PHY).
Code attribute under the element of Service (HAC) must = 47. If not present, an error will be returned.
Required when
SecurityCode attribute is NOT populated.
One and only one of the two code types must be present.
If more than one is present, an error will be returned.
SecurityCode
C
R
Refer to the
“HCD OTA
Supported Codes” spreadsheet for valid codes
Security Feature Code
(SEC)
Code attribute under the element of Service (HAC) must = 80. If not present, an error will be
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
returned.
Required when
AccessibleCode attribute is NOT populated.
One and only one of the two code types must be present.
If more than one is present, an error will be returned.
Languages
4
O
Only 1 element allowed per Property message.
Language
5
R
Required when Languages Element is present.
Language
R
US
Refer to the Appendix for valid codes.
Language(s) spoken at the property.
Standard ISO Language identifier.
Required when Language Element is present.
HotelStatus and HotelStatusCode
There is a hierarchical relationship between the HotelStatus attribute and the HotelStatusCode attribute of the HotelInfo element. The HotelStatusCode attribute defines whether the property is active, inactive, test, preopening, or deleted. This attribute drives whether a property can be included in search results.
The HotelStatus attribute defines the bookable status of the property for online channels. This attribute drives whether a property can accept online reservations.
The following table illustrates this relationship.
Bookable
Non-Bookable
Active
Property will be included in search responses and can receive online reservation requests.
Property will be included in search responses but can NOT receive online reservations.
Inactive
Property will not be returned in search responses and will NOT be allowed to receive online reservation requests.
“Inactive” overrides “Bookable”.
Property will not be returned in search responses and cannot receive online reservation requests.
Deleted
Property will not be returned in search responses and will NOT be allowed to receive online reservation requests.
“Delete” overrides “Bookable”.
Property will not be returned in search responses and will NOT be allowed to receive online reservation requests.
Test
Property will NOT be returned in search responses but WILL be allowed to receive online reservation requests.
Property will NOT be returned in search responses and will NOT be allowed to receive online reservation requests.
PreOpening
Property WILL be included in search responses and can receive online reservation requests.
NOTE: It will be up to the hotel CRS to disallow availability and booking requests that are prior to the opening date of the property.
Property will be included in search responses but can NOT receive online reservation requests.
Schema design view
Example transaction
Facility information
Although OpenTravel allows unlimited occurrences of each element within the
OTA_HotelDescriptiveContentNotifRQ message, ENTERPRISE CONNECTIVITY has elected to set limits for many of these elements. Unless specified under the Usage column below, ENTERPRISE CONNECTIVITY only allows one instance of each element per property message.
Element
Level
Attribute
R
O
C
G D
S
Example
Usage
Description
FacilityInfo
3
C
Element required when action code is Add or
Overwrite = true
Only 1 element allowed per Property message
MeetingRooms
4
O
Only 1 element allowed per Property message.
UnitOfMeasure
C
O
Square Feet
Square Meters
Feet
Meters
Unit of measure used to describe the dimensions.
When provided, this code will apply to all meeting room.
Enumerated attributed. Must use one of the values found in the Usage column.
MeetingRoomC ount
O
4
TotalRoomSpac e
O
1672
LargestRoomSp ace
O
968
LargestSeatingC apacity
O
418
SmallestRoomS pace
O
70
SmallestSeating Capacity
O
8
MeetingRoom
5
R
Required when
MeetingRooms Element is present.
RoomName
O
R
Meeting Room A
100 Char
Max: 200 bytes
Meeting Room name
RoomName is a multi-lingual attribute.
Removal
O
true false
If not specified, false is assumed.
ID
R
Meet001
32 Char
Unique Identifier
Required for MeetingRoom element.
Codes
6
O
Only 1 element allowed per Meeting Room.
Code
7
R
Required when Codes Element is present
ExistsCode
C
Refer to the
“HCD OTA
Supported Codes”
spreadsheet for valid codes.
Option Type Code (OTC).
Information under Code element will only be added when code = 1 or Attribute is not present.
Code
R
R
Refer to the
“HCD OTA
Supported
Meeting Room Code (MRC).
Required for Code element.
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
Codes”
spreadsheet for valid codes
CodeDetail
O
Blackboard available upon request.
64 Char
Max: 128 bytes
Meeting room code detail
This is meant to provide additional detail about the associated MRC code.
CodeDetail is a multi-lingual attribute.
Removal
O
true false
If not specified, false is assumed.
Dimension
6
O
Only 1 element allowed per Meeting Room
Area
C
O
2000.00
Decimal 8,2
Meeting Room dimensions
Only Required when action code is add or Overwrite = true
Height
O
O
33.50
Decimal 8,2
Meeting Room dimensions
Length
O
O
1000.00
Decimal 8,2
Meeting Room dimensions
Width
O
O
100.00
Decimal 8,2
Meeting Room dimensions
Units
C
O
Square Feet
Square Meters
Feet
Meters
Unit of measure used to describe the dimensions.
When provided this attribute will override the
UnitOfMeasureCode (under MeetingRooms) attribute for a specific meeting room.
Enumerated attributed. Must use one of the values found in the example.
AvailableCapacities
6
O
Only 1 element allowed per Meeting Room
MeetingRoomCapacity
7
R
Required when
AvailableCapacities is present
MeetingRoom FormatCode
R
O
Refer to the
“HCD OTA
Supported Codes”
spreadsheet for valid codes
Meeting Room Format Codes (MRF).
Required for
MeetingRoomCapacity element.
Occupancy
8
C
Only Required when action code is add or Overwrite = true
Only 1 element allowed per
Meeting Room Format
MaxOccupancy
R
O
400
4 Char
Maximum capacity for meeting room.
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
Required for Occupancy element.
Description
6
O
Only 1 element allowed per Meeting Room.
ContentID
O
MEET001
64 Char
Image Code
Text
7
O
O
A really big, great meeting room.
310 Char
Meeting Room description.
Only 1 Element allowed per meeting room. If more than one is present, an error will be returned.
Text is a multi-lingual attribute.
GuestRooms
4
C
Only Required when action code is add or Overwrite = true
Only 1 element allowed per Property message.
GuestRoom
5
R
Required when GuestRooms is present.
Code
O
R
A1K
5 Char
GDS room code.
MaxOccupancy
O
R
4
2 Char
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 these attributes are 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
O
3
Values 0 to 99
Maximum number of adults allowed in the room.
If present then
MaxChildOccupancy and MaxOccupancy are also required
The value cannot be greater than MaxOccupancy
MaxChild Occupancy
C
O
2
Value 0 to 99
Maximum number of children allowed in the room.
If present then
MaxAdultOccupancy and MaxOccupancy are also required
The value cannot be greater than MaxOccupancy
ID
R
Room001
32 Char
Unique Identifier
Required for GuestRoom
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
Element.
TypeRoom
6
O
Only 1 element allowed per Guest Room
Name
O
Deluxe Suite
32 Char
Max: 64 bytes
Name is a multi-lingual attribute.
RoomLocationC ode
O
Refer to the
“HCD OTA
Supported Codes”
spreadsheet for valid codes
Room Location Type (RLT) .
Only 1 code per GuestRoom ID element.
RoomViewCode
O
O
Refer to the
“HCD OTA
Supported Codes”
spreadsheet for valid codes
Room View (RVT).
Only 1 code per GuestRoom ID element.
BedTypeCode
O
Refer to the
“HCD OTA
Supported Codes”
spreadsheet for valid codes
Bed type (BED).
Only 1 code per GuestRoom ID element.
Amenities
6
C
Only Required when action code is add or Overwrite = true
Only 1 element allowed per Guest Room.
Amenity
7
R
Required when Amenities element is present.
RoomAmenityC ode
R
R
Refer to the
“HCD OTA
Supported Codes”
spreadsheet for valid codes
Room Amenity Type (RMA).
Required for Amenity element.
IncludedInRateI ndicator
O
O
true false
Indicates whether the amenity is included in the rate or at an extra charge.
Value will be defaulted to “false” if attribute is not sent in message.
ExistsCode
C
Refer to the
“HCD OTA
Supported Codes”
spreadsheet for valid codes.
Option Type Code (OTC).
Information under Amenity element will only be added when code = 1 or attribute is not present.
CodeDetail
O
AM/FM alarm clock radio
64 Char
Max: 128 bytes
Room amenity code detail
This is meant to provide additional detail about the associated
RoomAmenityCode
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
CodeDetail is a multi-lingual attribute.
Removal
O
true false
If not specified, false is assumed.
OperationSchedules
8
O
Only 1 element allowed per Amenity
OperationSchedule
9
R
Required when
OperationSchedules element is present.
Only 1 element allowed per
Amenity
Charge
10
O
Only 1 element allowed per Amenity
Amount
R
O
10.00
Decimal 12,3
Amenity charge / fee
Required for Charge Element
ChargeUnit
O
O
Refer to the
“HCD OTA
Supported Codes”
spreadsheet for valid codes.
Charge Unit (CHG).
Description
6
O
Only 1 element allowed per Guest Room.
ContentID
O
ROOM001
64 Char
Image Code
Text
7
O
O
A really great
room
310 Char
Description of the room
Only 1 Element allowed per guest room.
If more than one is present, an error will be returned.
Text is a multi-lingual element.
Restaurants
4
O
Only 1 element allowed per Property message.
Restaurant
5
R
Required when Restaurants Element is present.
RestaurantNam e
O
R
Suzie’s
Restaurant
100 Char
Max: 200 bytes
The name of the restaurant
RestaurantName is a multi- lingual attribute.
OfferBreakfast
O
O
true false
OfferLunch
O
O
true false
OfferDinner
O
O
true false
OfferBrunch
O
O
true false
ProximityCode
O
R
Refer to the
Proximity (PRX).
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
“HCD OTA
Supported Codes”
spreadsheet for valid codes
ID
R
Rest001
32 Char
Unique Identifier
Required for Restaurant element.
RestaurantDescription
6
O
Only 1 element allowed per Restaurant.
ContentID
O
REST001
64 Char
Image Code
Attire
O
Black tie
64 Char
Max: 128 bytes
Description field for attire required for the restaurant.
Only 1 attribute allowed per restaurant.
If more than one is present, an error will be returned.
Attire is a multi-lingual attribute.
Text
7
O
O
A very fancy restaurant.
310 Char
Restaurant Description
Only 1 Element allowed per restaurant. If more than one is present, an error will be returned.
Text is a multi-lingual element.
Relative Position
6
O
Only 1 Element is allowed per restaurant. If more than one is present, an error will be returned.
Distance
O
1.5
DistanceUnitNa me
O
Mile
Direction
O
NE
InfoCodes
6
O
Only 1 element allowed per Restaurant.
InfoCode
7
R
Required when InfoCodes is present.
Code
R
O
Refer to the
“HCD OTA
Supported Codes”
spreadsheet for valid codes
Restaurant Category (RES)
Required for InfoCode element.
Only 1 code allowed. If more than one is present, an error will be returned.
CodeDetail
O
Reservations are required
64 Char
Max: 128 bytes
Restaurant category code detail
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
This is meant to provide additional detail about the associated Restaurant Category (RES) code.
CodeDetail is a multi-lingual attribute.
Removal
O
true false
If not specified, false is assumed.
CuisineCodes
6
O
Only 1 element allowed per Restaurant.
CuisineCode
7
R
Required when
CuisineCodes is present.
Code
R
O
Refer to the
“HCD OTA
Supported Codes”
spreadsheet for valid codes
Main Cuisine Code (CUI).
Only 1 code allowed. If more than one is present, an error will be returned.
Required for CuisineCode element.
Removal
O
true false
If not specified, false is assumed.
SrvcInfoCodes
6
O
Only 1 element allowed per Restaurant.
SrvcInfoCode
7
R
Required when
SrvcInfoCodes is present.
Code
R
O
Refer to the
“HCD OTA
Supported Codes”
spreadsheet for valid codes
Restaurant Service Info (RSI).
Required for SrvcInfoCode element.
Removal
O
true false
If not specified, false is assumed.
Schema design view
Example transaction
Policy information
Although OpenTravel allows unlimited occurrences of each element within the
OTA_HotelDescriptiveContentNotifRQ message, ENTERPRISE CONNECTIVITY has elected to set limits for many of these elements. Unless specified under the Usage column below, ENTERPRISE CONNECTIVITY only allows one instance of each element per property message.
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
Policies
3
C
Element required when action code is Add or
Overwrite = true
Only 1 element allowed per Property message
Policy
4
R
Required when Policies element is present.
Only 1 element allowed per Property message.
CancelPolicy
5
O
R
Only 1 element allowed per Property message. Required for GDS content distribution.
CancelPenalty
6
R
Required when
CancelPolicy is present.
PolicyCode
R
CXL001
16 Char
Unique Identifier
Required for
CancelPenalty element.
Start
C
R
Date
Policy start date.
End
C
R
Date
Policy end date.
Deadline
7
R
Required when
CancelPolicy is present.
Only 1 element allowed per Cancel Penalty
AbsoluteDeadli ne
C
R
13:00:00
Time
Latest cancellation time on day of arrival.
Should only be used for day of arrival policies.
Only Required when action code is add or overwrite = true and when OffsetTimeUnit,
OffsetUnitMultiplier, and OffsetDropTime attributes are not populated.
OffsetTimeUnit
C
R
Hour
Day
Hour
Year
Month
Week
Second
Full Duration
Cancellation deadline unit.
To be used in conjunction with OffsetUnitMultiplier.
Should only be used for policies not associated to day of arrival.
Enumerated attributed. Must use one of the values found in the example.
Only Required when action code is add or
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
overwrite = true and when AbsoulteDeadline is not populated.
OffsetUnitMult
iplier
C
R
24
4 Char
Cancellation deadline other than day of arrival time.
To be used in conjunction with OffsetTimeUnit and OffsetDropTime.
Should only be used for policies not associated to day of arrival.
Only Required when action code is add or Overwrite = true and when AbsoulteDeadline is not populated.
OffsetDropTim e
C
R
BeforeArrival
AfterBooking
Cancellation period.
To be used in conjunction with OffsetUnitMultiplier and OffsetTimeUnit.
Should only be used for policies not associated to day of arrival.
Enumerated attributed. Must use one of the values found in the example.
Only Required when action code is add or Overwrite = true and when AbsoulteDeadline is not populated.
AmountPercent
7
C
Only Required when action code is add or Overwrite = true
Only 1 element allowed per Deadline
TaxInclusive
O
true false
Identifies if tax is included in cancel penalty.
Value will be defaulted to “false” if attribute is not sent in message.
NmbrOfNights
C
R
1
4 Char
Cancel penalty stated as number of nights.
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
Required when Amount or Percent attributes are NOT populated.
If more than one is present, an error will be returned.
Percent
C
R
20
3 Char
Cancel penalty stated as percent.
Required when Amount or NmbrOfNights attributes are NOT populated.
If more than one is present, an error will be returned.
Amount
C
R
50.00
Decimal 12,3
Cancel penalty stated as amount.
Required when Percent or NmbrOfNights attributes are NOT populated.
If more than one is present, an error will be returned.
PenaltyDescription
7
O
Only 1 element allowed per Cancel Penalty.
Text
8
O
Loss of deposit if not cancelled within cancellation period.
310 Char
Cancel policy description
If more than one is present, an error will be returned.
Text is a multi-lingual element.
GuaranteePaymentPolicy
5
O
Only 1 element allowed per Property message.
GuaranteePayment
6
R
Required when
GuaranteePaymentPolicy is present.
GuaranteeCod
e
R
GuaranteeDep
ositPolicy
MethodOfPay mentPolicy
CreditCardPoli cy
Policy type indicator.
Indicates whether the element contains guarantee policy or payment method information.
GuaranteeType
R
Deposit
GuaranteeReq uired None
Guarantee type indicator.
Required only when
GuaranteeCode =
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
GuaranteeDepositPolicy.
PaymentCode
C
R
Refer to the
“HCD OTA
Supported Codes” spreadsheet for valid codes
Payment Type (PMT).
Required only when
GuaranteeCode =
MethodOfPaymentPolicies
.
Type
C
R
RequiredPaym ent
GuaranteePoli cy
AcceptedPaym entForms
Transaction Type
Indicates the Transaction Type for which the payment method applies.
Enumerated attributed. Must use one of the values found in the Usage column.
RequiredPayment = Deposit
GuranteePolicy =
Guarantee
AcceptedPaymentForms =
Settlement
Required only when
GuaranteeCode =
MethodOfPaymentPolicies
.
HoldTime
C
R
17:00:00
Time
Reservation hold time.
Required when
GuaranteeType = None.
Mon
C
O
true false
At minimum one Day of Week must be chosen.
Tue
C
O
true false
At minimum one Day of Week must be chosen.
Weds
C
O
true false
At minimum one Day of Week must be chosen.
Thur
C
O
true false
At minimum one Day of Week must be chosen.
Fri
C
O
true false
At minimum one Day of Week must be chosen.
Sat
C
O
true false
At minimum one Day of Week must be chosen.
Sun
C
O
true false
At minimum one Day of Week must be chosen.
Start
R
R
2006-01-01
Date
Policy start date.
See the business rules for more details.
End
R
R
2006-12-31
Date
Policy end date.
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
Please see the business rules for more details.
AcceptedPayments
7
C
Element must be present
when PaymentCode
attributed under
GuaranteePayment Element is populated with the code equal to Credit Card.
Only 1 element allowed per Guarantee Payment.
AcceptedPayment
8
R
Required when AcceptedPayments element is present.
Only 1 Payment Card element allowed per Accepted Payment
PaymentCard
9
C
CardCode
C
R
VI
Refer to the Appendix for the valid codes.
Credit card issuer code.
Attribute must be populated when
PaymentCode attributed under GuaranteePayment Element is populated with the code equal to Credit Card.
Description
7
O
Only 1 element allowed per Guarantee Payment
Text
8
O
Guarantee to 1 night room and tax.
310 Char
Guarantee / Deposit Policy description
Required when
Description Element is present.
Only 1 Element allowed per PaymentCode / Type combination. If more than one is present, an error will be returned.
Text is a multi-lingual element.
CheckoutCharges
5
O
Only 1 element allowed per Property message.
CheckoutCharge
6
R
Required when CheckoutCharges is present.
Only 1 element allowed per Property message.
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
Amount
C
R
50.00
Decimal 12,3
Early check-out charge stated as amount.
Required when Percent or NmbrofNights are NOT populated.
Percent
C
R
20
3 Char
Early check-out charge stated as percent.
Required when Amount or NmbrOfNights are NOT populated.
NmbrOfNights
C
R
1
2 Char
Early check-out charge stated as number of nights.
Required when Amount or Percent are NOT populated.
Removal
O
true false
If not specified, false is assumed.
Description
7
O
Only 1 element allowed per Checkout Charge.
Text
8
O
Please check with front desk for further details.
310 Char
Early check-out policy description text.
Required when
Description Element is present.
Only 1 Element allowed per checkout charge.
If more than one is present, an error will be returned.
Text is a multi-lingual element.
PolicyInfo
5
C
Only Required when action code is add or Overwrite = true
Only 1 element allowed per Property message.
CheckInTime
C
R
14:00:00
Time
Check-in time.
Only Required when action code is add or Overwrite = true.
CheckOutTime
C
R
12:00:00
Time
Check-out time.
Only Required when action code is add or
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
Overwrite = true.
UsualStayFree CutoffAge
C
12
2 Char
Stay free child age limit.
Only Required when KidsStayFree Attribute = true
UsualStayFree ChildPerAdult
O
2
2 Char
Stay free child maximum per adult.
Note: the
ChildPolicyExtended TPA extension can be used to define more complicated policies.
KidsStayFree
C
R
true false
Children stay free indicator.
Only Required when action code is add or Overwrite = true.
Description
6
O
Only 1 element allowed per Policy Info.
Text
7
R
Children under 10 must be accompanie d by an adult in all public areas at all times.
310 Char
Child policy description.
Required for Description Element. If more than one is present, an error will be returned.
Text is a multi-lingual element.
TaxPolicies
5
C
Only Required when
action code is add
Only 1 element allowed per Property message.
TaxPolicy
6
R
Required when TaxPolicies element is present.
Code
R
R
Refer to the
“HCD OTA
Supported Codes” spreadsheet for valid codes
Fee Tax Type (FTT).
Required for TaxPolicy element.
GDS Note: Element required with a value of “19” (VAT/GST tax) when property’s information is delivered to the GDSs. If tax code is not applicable to the property, it should be sent with Amount=”0”, but it must be sent.
Type
C
R
Inclusive
Values
“Inclusive” or
“Exclusive”
Defines whether tax is included in the fee.
Percent
C
R
15
3 Char
Fee or tax stated as a percent.
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
Attribute cannot be populated if Amount attribute is populated.
Attribute required when action code is add or Overwrite = true.
Amount
C
R
20.00
Decimal 12,3
Fee or tax stated as an amount.
Attribute cannot be populated if Percent attribute is populated.
Attribute required when action code is add or Overwrite = true.
ChargeUnit
R
O
Refer to the
“HCD OTA
Supported Codes” spreadsheet for valid codes
Charge Type (CHG)
Required for TaxPolicy element.
EffectiveDate
C
C
2011-01-01
Date
These dates specify when the tax policy is active.
The start and end dates are optional, but if one is specified then so must the other. For open-ended taxes/fees, an arbitrary end date in the 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, although the end data cannot be before the start date
ExpireDate
C
C
2015-12-31
Date
TaxDescription
7
C
Only 1 element allowed per Tax Policy.
A tax/fee description is normally optional and can be used to provide additional information about the policy.
However, the description is required when there is more than one TaxPolicy with the same Code and ChargeUnit that are active at the same time. In this
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
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 of more does not have effective dates specified (i.e. it is always active).
Text
8
R
Tax is applied to all fees.
310 Char
Tax policy description text.
Required when
TaxDescription Element is present.
Only 1 Element allowed per tax policy. If more than one is present, an error will be returned.
Text is a multi-lingual element.
PetsPolicies
5
O
Only 1 element allowed per Property message.
PetsAllowedCo de
O
O
“Pets Allowed”
“Pets Not
Allowed”
Pet acceptance indicator.
For more detailed Pet Policy information, see Element PetPolicy.
Enumerated attributed. Must use one of the values found in the Usage column.
PetsPolicy
6
O
PetsPolicyCode
R
Refer to the
“HCD OTA
Supported Codes” spreadsheet for valid codes
Pet Policy (PET).
Required for PetPolicy element.
Description
7
R
Required when PetsPolicy element is present.
Only 1 element allowed per Pet Policy.
Text
8
O
Pets allowed under 15 lbs.
310 Char
Pet policy description.
Required when
Description element is present.
Element
Level
Attribute
R
O
C
G
D
S
Example
Usage
Description
Only 1 element allowed. If more than one is present, an error will be returned.
Text is a multi-lingual element.
CommissionPolicy
5
O
R
Only 1 element allowed per Property message.
CommissionAp
plicability
O
R
SomeRates
AllRates
SomeRates
NoRates
Indicates whether the property pays commission on all, some or no rates. Required for properties subscribing to GDS content updates via HCD.
Description
6
O
Only 1 element allowed per Commission Policy.
Text
7
O
10%
Commission
310 Char
Commission policy description.
Required when
Description Element is present.
Only 1 element allowed. If more than one is present, an error will be returned.
Text is a multi-lingual element.
PaymentCompany
6
O
R
Only 1 element allowed per Commission Policy. Mandatory for properties subscribing to GDS content updates via HCD.
Name
R
O
H
1 Char
Commission payment service identifier.
Required for
PaymentCompany element.
H = ENTERPRISE CONNECTIVITY Commission
Processing (previously
HCC)
C = NPC
W = WPS
P = Perot Systems
O = Other Commission
Processing Vendor
N = None
Schema design view
Example transaction
Last updated
