Transaction specifications
The following sections describe in detail the message structure required to perform various updates of hotel data within the HCD.
The payload for transactions received by RateGain should follow the schema defined for the OTA_HotelDescriptiveContentNotifRQ (version 2005B) message. The payload for transactions returned to the client by RateGain will follow the schema defined for the OTA_HotelDescriptiveContentNotifRS (version 2005B) message.
Element table definitions
Each transaction is defined in terms of the elements and attributes that are used within that transaction. For each element or attribute, the following information is presented:
Column Heading
Description
Element Name
The name of the element
Attribute Name
The name of the attribute
Level
The depth of the current element in the XML tree structure, with ‘0’ being the root element in the message
.
Required / Optional / Conditional
Identification code to state if the element or attribute is: R Required – Must be populated within the message O Optional – Not required for processing
C Conditional - The element or attribute contains a specific condition that must be met for processing.
GDS
Identification code to state if the data found in the element or attribute will be delivered to the GDS and if it is required or optional for GDS updating.
R Required – Must be populated for the property in order to deliver updates to the GDS. A warning will be returned if not present.
O Optional – The data will be delivered to the GDS only if present.
C Conditional – The element or attribute contains a specific condition that must be met for delivery to the GDSs.
No value in this column indicates the data will never be delivered to the GDSs. NOTE: GDS updates will only occur if the hotel chain has subscribed to the GDS updating service via HCD.
Example
Example data for free form text fields
Usage
Indicates the max length, codes list or valid enumeration values for the field. The definitions found within the OTA XML schemas will apply unless specifically stated within this section. When length is specified in bytes, this indicates a multi-lingual field and the value is applicable to non-English text.
Description
Additional information associated to the element or attribute. See GDS Notes in this column for further information on delivery of HCD data to the GDSs.
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, RateGain has elected to set limits for many of these
elements. Unless specified under the Usage column below, RateGain 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. Must be uppercase.
HotelCode
R
YY1234
10 Char
Hotel property identification code.
Required for OTA_HotelDescriptiveCo ntent element. Must be uppercase.
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
2000
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.
HotelShortName
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
2025-01-01
Date
Start of the hotel property seasonal closings.
Required for ClosedSeason Element.
End
R
2025-02-01
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
2020
4 Char
4-digit year the property was last renovated.
Description
5
C
Only Required when action code is add or Overwrite = true
AdditionalDetailCode
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
Figure: Basic Property Information
Example transaction
Facility information
Although OpenTravel allows unlimited occurrences of each element within the OTA_HotelDescriptiveContentNotifRQ message, RateGain has elected to set limits for many of these
elements. Unless specified under the Usage column below, RateGain only allows one instance of each element per property message.
Level 1 & 2 elements and attributes are addressed below:
Element
Level
Attribute
R O
C
G D S
Example
Usage
Description
FacilityInfo
3
C
Element required when action code is Add or
Element
Level
Attribute
R O
C
G D S
Example
Usage
Description
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.
MeetingRoomCount
O
4
TotalRoomSpace
O
1672
LargestRoomSpace
O
968
LargestSeatingCapacity
O
418
SmallestRoomSpace
O
70
SmallestSeatingCapacity
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
MaxChildOccupancy
C
O
2
Values 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.
RoomAmenityCode
R
R
Refer to the “HCD OTA
Supported Codes” spreadsheet for valid codes
Room Amenity Type (RMA).
Required for Amenity element.
IncludedInRateIndicator
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.
RestaurantName
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
DistanceUnitName
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
Figure 4-2: Facility Information: General
Example transaction
Policy information
Although OpenTravel allows unlimited occurrences of each element within the OTA_HotelDescriptiveContentNotifRQ message, RateGain has elected to set limits for many of these
elements. Unless specified under the Usage column below, RateGain only allows one instance of each element per property message.
Level 1 & 2 elements and attributes are addressed below
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
Policies
3
C
Element required when action code is Add or
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
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
2024-10-15
Date
Policy start date.
See the business rules for more details.
End
R
R
2030-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
2020-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
2030-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 = RateGain Commission Processing (previously HCC)
C = NPC W =WPS
P = Perot Systems
O = Other Commission Processing Vendor
N = None
Schema design view
Example transaction
Area Information
Although OpenTravel allows unlimited occurrences of each element within the OTA_HotelDescriptiveContentNotifRQ message, RateGain has elected to set limits for many of these
elements. Unless specified under the Usage column below, RateGain only allows one instance of each element per property message.
Level 1 & 2 elements and attributes are addressed in section 4.2.1.
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
AreaInfo
3
C
Element required when action code is Add or Overwrite = true
Only 1 element allowed per Property message.
Attractions
4
C
Only Required when action code is add or Overwrite = true
Only 1 element allowed per Property message.
Attraction
5
R
Required when Attractions element is present.
AttractionCat egoryCode
C
R
Refer to the “HCD OTA
Supported Codes” spreadsheet for valid codes
Attraction Category Code (ACC).
Only Required when action code is add or Overwrite = true
Same Code can be provided with new ID attribute.
GDS Note: When property’s information is
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
delivered to the GDSs, must have one Attraction with AttractionCategoryCo de of “1” (Airport), and one with AttractionCategoryCo de of “67” (City Center) or “68” (City Downtown) with PrimaryIndicator=”tru e”.
AttractionNa me
O
O
Six Flags
64 Char
Max: 128
bytes
The name of the attraction
AttractionName is a multi-lingual attribute.
Code
C
R
DFW
3 Char
Airport Code
Attribute is ONLY used and Required when AttractionCategoryCo de is “1” (Airport).
Removal
O
true false
If not specified, false is assumed.
ID
R
ACC001
32 Char
Unique Identifier
Required for Attraction element.
Contact
6
O
Only 1 element allowed per Attraction.
Removal
O
true false
If not specified, false is assumed.
URLs
7
O
Only 1 element allowed per Attraction.
URL
8
R
www.sixfl aggs.com
128 Char
Attraction website address
Only one Element per Attraction allowed.
If more than one
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
element is present, an error will be returned.
Required when URLs element is present.
Description
6
O
Only 1 element allowed per Attraction.
ContentID
O
AREA002
64 Char
Image Code
Text
7
O
310 Char
Attraction description
Only one Element per Attraction allowed.
If more than one element is present, an error will be returned.
Text is a multi-lingual element.
RefPoints
6
O
Only 1 element allowed per Attraction.
RefPoint
7
R
Required when RefPoints is present.
Only 1 element allowed per Attraction.
Direction
O
R
N NE NW S SE SW E W
Defines the cardinal direction
Enumerated attributed. Must use one of the values found in the example.
Distance
C
R
12
Decimal 5,2
Distance to/from Reference Point.
Only Required when action code is add or Overwrite = true.
DistanceUnit Name
C
R
Mile Km
When provided this attribute will override
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
Block
the UnitOfMeasureCode (under HotelDescriptiveCont ent) attribute for a specific attraction.
Enumerated attributed. Must use one of the values found in the example.
PrimaryIndicator
C
R
true false
Indicates whether the reference point is considered the main reference point for the specific type Attraction Category Code (ACC).
If NOT populated, will be defaulted to false.
GDS Note: If AttractionCategoryCo de is “1” (Airport), “67” (City Center) or “68” (City Downtown), one must have PrimaryIndicator set to “true”.
Proximity
O
C
3
The valid values are a subset of the LOC code list: “1” = Airport
(within 5 Mi/8 Km of property) “3” = City
“10” = Resort
“11” = Rural
“13” =
Suburban “29” = North suburb
“30” = South suburb
This is only applicable to “airport” attractions (AttractionCategoryC ode=”1”).
Mandatory for properties subscribing to GDS content updates via HCD
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
“31” = East suburb “32” = West suburb
CityCode
O
R
DAL FTW MIA
3 Char
City Code
Attribute is ONLY used when AttractionCategoryCo de is “67” (City Center) or “68” (City Downtown).
Removal
O
true false
If not specified, false is assumed.
Transportations
8
O
Only 1 element allowed per RefPoint.
Transportation
9
O
Required with Transportations Element is present
Transportati onCode
R
R
Refer to the “HCD OTA
Supported Codes” spreadsheet for valid codes
Transportation Code (TRP).
Required for Transportation element.
GDS Note: Must be populated for ACC = 1, 67 or 68 when property’s information is delivered to the GDSs.
Included
O
O
false
Boolean
Specifies whether the transportation method is complimentary – e.g. for a free shuttle.
Amount
O
10.00
Decimal 12,3
Cost of transportation to/from Reference Point.
ChargeUnit
O
O
CHG code list
Specifies what the Amount applies to – e.g. one-way, round-trip etc.
Removal
O
true false
If not specified, false is assumed.
Descriptions
10
O
Only 1 element allowed per Attraction.
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
Description
11
R
Required when Descriptions Element is present.
Only 1 element allowed per Attraction.
Text
12
O
R
Most car rental companies have counters at OHare International Airport.
1,024 Char
Max: 2,000
bytes
Transportation description
Required when Description element is present.
Only 1 Element allowed per AttractionCategoryCo de / 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
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.
Only 1 element allowed per Service
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.
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
Mon
C
O
Tue
C
O
Weds
C
O
Thur
C
O
Fri
C
O
Sat
C
O
Sun
C
O
Start
C
O
08:00:00
End
C
O
23:00:00
Descriptions
8
O
Only 1 element allowed per Attraction.
Description
9
R
Required when Descriptions Element is present.
Only 1 element allowed per Attraction.
Text
10
O
R
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
Only 1 element allowed per Property message.
Recreation
5
R
Required when Recreations element is present.
CodeDetail
O
Please contact front desk for tee times.
64 Char
Max: 128
bytes
Recreation Service Type code detail
This is meant to provide additional detail about the associated RST code.
CodeDetail is a multi- lingual attribute.
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
ExistsCode
C
Refer to the “HCD OTA
Supported Codes” spreadsheet for valid codes.
Option Type Code (OTC).
Information under Recreation element will only be added when code = 1 or attribute is not present.
Removal
O
true
If not specified, false
false
is assumed.
Code
R
O
Refer to the “HCD OTA
Supported Codes” spreadsheet for valid codes
Recreation Service Type (RST).
Required for Recreation Element.
ProximityCod e
O
O
Refer to the “HCD OTA
Supported Codes” spreadsheet for valid codes
Proximity Table (PRX).
Included
O
O
true false
Whether or not the recreation is included with the room rate, or if there is an extra charge.
Value will be defaulted to “false” if attribute is not sent in message.
Description
6
O
Only 1 element allowed per Recreation.
ContentID
O
POOL001
64 Char
Image Code
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
Text
7
O
This is a great recreation
310 Char
Recreation description
Only 1 Element allowed per recreation.
If more than one is present, an error will be returned.
Text is a multi-lingual element.
RecreationDetails
6
O
Only 1 element allowed per Recreation.
RecreationDetail
7
R
Required when RecreationDetails is present.
Code
R
O
Refer to the “HCD OTA
Supported Codes” spreadsheet for valid codes
Recreation Srvc Detail Code (REC).
Required for RecreationDetail element.
CodeDetail
O
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.
ExistsCode
C
Refer to the “HCD OTA
Supported Codes” spreadsheet for valid codes.
Option Type Code (OTC).
Information under RecreationDetail element will only be added when code = 1 or attribute is not present.
Removal
O
true false
If not specified, false is assumed.
Schema design view
Figure 4-4 Area Information
example transaction 4.2.4.2
<OTA_HotelDescriptiveContentNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="4.000" PrimaryLangID="EN">
<HotelDescriptiveContents>
<HotelDescriptiveContent UnitofMeasureCode="1" CurrencyCode="USD" TimeZone="CST" BrandCode="ZZ" HotelCode="AA123" HotelName="Test Hotel" Overwrite="false">
<AreaInfo>
<Attractions>
<Attraction ID="ARPT1" AttractionCategoryCode="1" AttractionName="DFW Airport" Code="DFW">
<RefPoints>
<RefPoint Direction="W" Distance="15.00" DistanceUnitName="Mile" PrimaryIndicator="true" Proximity="4">
<Transportations>
<Transportation TransportationCode="17" Included="true">
<OperationSchedules>
<OperationSchedule>
OperationTimes>
<OperationTime Sun="true"
Start="06:00:00" End="18:00:00"/>
<OperationTime Start="06:00:00"
End="20:00:00" Mon="true"/>
<OperationTime Start="06:00:00"
End="18:00:00" Tue="true"/>
<OperationTime Start="06:00:00"
End="20:00:00" Weds="true"/>
<OperationTime Start="06:00:00"
End="18:00:00" Thur="true"/>
<OperationTime Start="06:00:00"
End="20:00:00" Fri="true"/>
<OperationTime Start="06:00:00"
End="18:00:00" Sat="true"/>
</OperationTimes>
</OperationSchedule>
</OperationSchedules>
</Transportation>
</Transportations>
<Descriptions>
<Description>
<Text>Airport Directions</Text>
</Description>
</Descriptions>
</RefPoint>
</RefPoints>
</Attraction>
</Attractions>
</AreaInfo>
<Recreations>
<Recreation ExistsCode=”1” CodeDetail="Golf" Removal="false" Code="27" ProximityCode="2"
Included="false">
<Description ContentID="Rec001">
<Text>Hank Haney's Golf Center</Text>
</Description>
<RecreationDetails>
<RecreationDetail ExistsCode=”1” Code="1" CodeDetail="Driving range" Removal="false"/>
<RecreationDetail ExistsCode=”1” Code="5" CodeDetail="Putting green" Removal="false"/>
<RecreationDetail ExistsCode=”1” Code="6" CodeDetail="Golf clubs available for rental or
purchase" Removal="false"/>
</RecreationDetails>
</Recreation>
</Recreations>
</AreaInfo>
</HotelDescriptiveContent>
</HotelDescriptiveContents>
</OTA_HotelDescriptiveContentNotifRQ>
affiliation information 4.2.5
Although OpenTravel allows unlimited occurrences of each element within the OTA_HotelDescriptiveContentNotifRQ message, RateGain has elected to set limits for many of these
elements. Unless specified under the Usage column below, RateGain only allows one instance of each element per property message.
Level 1 & 2 elements and attributes are addressed in section 4.2.1.
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
AffiliationInfo
3
O
Only 1 element allowed per Property message.
Awards
4
C
Required when AffiliationInfo element is present and LoyalPrograms element is not present.
Only 1 element allowed per Property message.
Award
5
R
Required when Awards element is present.
Removal
O
true false
If not specified, false is assumed.
Date
O
2024-01-01
Date
Reflect the date the award was given.
Provider
R
Dallas Chamber of Commerce
100 Char
Max: 200 bytes
Name of provider who gave award.
Required for Award element.
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
Rating
C
4 Stars
100 Char
Max: 200 bytes
Hotel rating.
Example: “3 Stars – Star Magazine, 2 Circles - Circle Magazine”
Note: Input of the American Auto Association (AAA) trademarks and references to diamond ratings is prohibited by AAA. If found an error will be returned.
Only Required when action code is add or Overwrite = true
Only 1 rating per provider attribute allowed. If more than one is present, an error will be returned.
Rating is a multi-lingual attribute.
LoyalPrograms
4
C
Required when AffiliationInfo element is present and Awards element is not present.
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
64 Char
Max 128 bytes
Loyal programs name, e.g. “La Quinta Returns”
HotelLevel
O
16 Char
Max 32 bytes
The level/tier that the hotel participates in the loyalty program. This may affect the number of ‘points’ received for a stay or the number of points required to redeem free nights.
Examples:
“B” (level B)
“2” (Level 2)
“Tier 2”
Example transaction
Affiliation information
Although OpenTravel allows unlimited occurrences of each element within the OTA_HotelDescriptiveContentNotifRQ message, RateGain has elected to set limits for many of these
elements. Unless specified under the Usage column below, RateGain only allows one instance of each element per property message.
Level 1 & 2 elements and attributes are addressed in section 4.2.1.
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
AffiliationInfo
3
O
Only 1 element allowed per Property message.
Awards
4
C
Required when AffiliationInfo element is present and LoyalPrograms element is not present.
Only 1 element allowed per Property message.
Award
5
R
Required when Awards element is present.
Removal
O
true false
If not specified, false is assumed.
Date
O
2024-01-01
Date
Reflect the date the award was given.
Provider
R
Dallas Chamber of Commerce
100 Char
Max: 200 bytes
Name of provider who gave award.
Required for Award element.
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
Rating
C
4 Stars
100 Char
Max: 200 bytes
Hotel rating.
Example: “3 Stars – Star Magazine, 2 Circles - Circle Magazine”
Note: Input of the American Auto Association (AAA) trademarks and references to diamond ratings is prohibited by AAA. If found an error will be returned.
Only Required when action code is add or Overwrite = true
Only 1 rating per provider attribute allowed. If more than one is present, an error will be returned.
Rating is a multi-lingual attribute.
LoyalPrograms
4
C
Required when AffiliationInfo element is present and Awards element is not present.
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
64 Char
Max 128 bytes
Loyal programs name, e.g. “La Quinta Returns”
HotelLevel
O
16 Char
Max 32 bytes
The level/tier that the hotel participates in the loyalty program. This may affect the number of ‘points’ received for a stay or the number of points required to redeem free nights.
Examples:
“B” (level B)
“2” (Level 2)
“Tier 2”
Schema design view
Example transaction
Media information
The media information section (MultimediaObjects elements and attributes) are only sent by Suppliers that DO NOT contract with ICE Portal or Leonardo as their image provider. ICE Portal and Leonardo provide image information for their partners directly to RateGain.
Level 1 & 2 elements and attributes are addressed in section 4.2.1.
Element
Level
Attribute
R O C
G D S
Exampl e
Usage
Description
MultimediaObjects
3
O
ONLY used by Suppliers that do not utilize ICE Portal or Leonardo as their image provider.
Only 1 element allowed per Property message.
MultimediaObject
4
R
ParagraphNum ber
R
3
This will represent the order of the images in ascending order by number beginning with 1.
The number 1 will equate to the first picture (link) that is pulled for displayed.
Removal
O
true false
ContentData
R
A
The type of content the supplier will provide.
Only ContentData =“A” will be allowed.
Description
O
310 Char
Image Description
PictureCategory Code
R
Refer to the “HCD OTA
Supported Codes” spreadshe et for valid codes
Picture Category Code (PIC).
Same Picture Category Code can be submitted with a new ContentID and/or Paragraphnumber attribute.
ContentCaption
R
This is a great pool.
50 Char
Max: 100
bytes
Image Caption Text
URL
R
256 Char
URL of image file that contains corresponding image.
ContentID
R
Pool00 1
64 Char
Unique Indicator to tie back to the Property data.
This ID should match an ID that was provided within the property data or to link at property level, include the brand and property ID, eg. XX12345.
Schema design view
Example transaction
Contact information
Although OpenTravel allows unlimited occurrences of each element within the OTA_HotelDescriptiveContentNotifRQ message, RateGain has elected to set limits for many of these
elements. Unless specified under the Usage column below, RateGain only allows one instance of each element per property message.
Level 1 & 2 elements and attributes are addressed in section 4.2.1.
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
ContactInfos
3
C
Element required when action code is Add or Overwrite = true
Only 1 element allowed per Property message.
ContactInfo
4
R
Required when ContactInfos element is present.
Only 1 element allowed per Property message.
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
Removal
O
true false
If not specified, false is assumed.
Addresses
5
C
Only Required when action code is add, Overwrite = true or when adding additional language.
Only 1 element allowed per Property message.
Address
6
R
Required when Addresses element is present.
UseType
R
R
Refer to the “HCD OTA
Supported Codes” spreadsheet for valid codes
Address Use Type (AUT).
Required for Address element.
GDS Note: Address Use Type of 5 (Other) will default all address elements/attributes to the usage limitations for the GDSs.
Removal
O
true false
If not specified, false is assumed.
AddressLine
7
C
R
1530
N. Central Expressway
255 Char
GDS Max: 50
Char
Hotel property address.
5 text line are available for the complete address of the property.
Only Required when action code is add, Overwrite = true or when adding additional language.
AddressLine is a multi- lingual attribute.
GDS Note: Only the first 2 lines of address will be delivered to the GDSs.
CityName
7
C
R
Dallas
64 Char
Max: 128 bytes
GDS Max: 50
Char
Hotel property city
Only Required when action code is add, Overwrite = true or when adding additional language.
CityName is a multi-lingual attribute.
PostalCode
7
O
R
75305
16 Char
GDS Max: 10
Char
Hotel property postal code
County
7
O
O
Dallas
32 Char
Max: 64 bytes
Hotel property county
County is a multi-lingual
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
GDS Max: 30
Char
attribute.
StateProv
7
C
Only 1 element allowed per Address.
StateCode
C
C
TX
Refer to the Appendix for valid codes
Hotel property state/province code.
If the Hotel Property Country is either “AU”, “BR”, “CA”, “DE”, “MX”, or
“US” , the state/province code is validated, otherwise it is not.
GDS Note: Attribute is required for the above countries when delivering data to the GDSs.
CountryName
7
C
Only Required when action code is add or Overwrite = true
Only 1 element allowed per Address.
Code
R
R
US
Refer to the Appendix for valid codes
Hotel property country code.
Required for CountryName element.
Phones
5
C
Only Required when action code is add or Overwrite = true
Only 1 element allowed per Property message.
Phone
6
R
Required when Phones Element is present.
PhoneLocationT ype
R
O
Refer to the “HCD OTA
Supported Codes” spreadsheet for valid codes
Phone Location Type (PLT).
Required for Phone element.
At least one phone number with PhoneLocationType = 4 and PhoneTechType = 1 must be present per property.
Phone Location Type of 8 (Other) will default all phone elements/attributes to the usage limitations for the GDSs.
PhoneTechType
R
R
Refer to “HCD OTA Supported Codes” spreadsheet for valid codes.
Phone Tech Type (PTT).
Only codes of 1, 3, 6, or 7 will be accepted. All other
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
Only codes 1, 3,
6, and 7 will be accepted in this context.
codes will generate an error.
Required for Phone element.
CountryAccessCode
C
R
011
3 Char
The countries direct dial prefix
Attribute required when PhoneLocationType = 4.
CountryAccessCode value must match Property’s Country Code. See appendix for codes.
If not populated when required or value is not valid an error is generated.
GDS Note: HCD can collect more than 1 code per country. Defaults will be applied when sent to the GDSs. See appendix for codes.
AreaCityCode
O
O
972
8 Char
Hotel property area code
PhoneNumber
C
R
555-1212
32 Char
GDS Max: 30
Char
Hotel property number
Only Required when action code is add or Overwrite = true.
Emails
5
O
Only 1 element allowed per Property message.
6
R
O
joebob@my hotel.com
128 Char
Hotel property Internet e- mail ID.
Only one ID per EmailType is allowed. More than one will generate an error.
Attribute required when Emails
EmailType
R
O
5
Refer to “HCD OTA Supported Codes” spreadsheet for valid codes.
Only codes of 5 & 7 will be accepted in this context.
Email Address Type (EAT).
Only codes of 5 and 7 will be accepted. All others codes will generate an error.
Required for Email Element.
Removal
O
true false
If not specified, false is assumed.
URLs
5
O
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
URL
6
R
128 Char
Hotel website URL.
Only one Element per ContactInfo allowed. If more than one element is present, an error will be returned.
Schema design view
Example transaction
TPA extensions 4.2.8
Although OpenTravel allows unlimited occurrences of each element within the OTA_HotelDescriptiveContentNotifRQ message, RateGain has elected to set limits for many of these
elements. Unless specified under the Usage column below, RateGain only allows one instance of each element per property message.
Level 1 & 2 elements and attributes are addressed in section 4.2.1.
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
TPA_Extensions
3
O
Only 1 element allowed per Property message.
TPA_Extension
4
R
Required when TPA_Extensions is present.
Only 1 element allowed per Property message.
USWInfo
5
O
Only 1 element allowed per Property message.
Required if brand code and/or property ID differs between HCD and USW.
Chain
R
ZZ
2 to 3 Char
USW Chain Code
PID
R
ZZ1234
10 Char
USW Property ID
EAPInfo
5
O
O
This is only applicable for properties subscribing to the GDS update service.
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
GDSName
O
O
30 Char
Property name to be sent to the GDSs. If the GDSName is not provided, the first 30 characters of the full property name will be sent to the GDS.
HotelFacts
5
O
Only 1 element allowed per Property message.
HotelFact
6
R
Required when HotelFacts is present.
Fact
C
Pool is closed June 12th – 25th.
180 Char
Max: 360
bytes
Fact about the hotel.
Only Required when action code is add or Overwrite = true.
Fact is a multi-lingual attribute.
Start
C
2025-01-01
Date
Start date for when the fact is visible.
Only Required when action code is add or Overwrite = true
End
C
2025-06-26
Date
End date for when the fact is no longer visible.
Only Required when action code is add or Overwrite = true
Removal
O
true
If not specified, false is
assumed.
FactId
R
32 Char
Unique Identifier
Required for HotelFact Element.
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
GuaranteePaymentExten ded
5
O
Only 1 element allowed per Property message. It is recommended that the
GDSGuaranteePayments element is used instead, as this allows late arrivals to vary by date range and day of week.
lateArrivalsAllo wed
R
O
true false
Defines if late arrivals are allowed at the property.
GDSGuaranteePayments
5
O
O
This is used to define whether late arrivals are allowed at the property. This can vary by date period and days of week.
GDSGuaranteePayment
6
R
R
lateArrivalsAllo wed
R
O
true false
Defines if late arrivals are allowed at the property.
Start
R
R
2024-10-15
Date
The Start Date associated to the Late Arrival policy.
Please see the business rules for more details.
End
R
R
2030-12-31
Date
The End Date associated to the Late Arrival policy.
Please see the business rules for more details.
Mon
R
O
true false
At minimum one Day of Week must be chosen.
Tue
R
O
true false
At minimum one Day of Week must be chosen.
Weds
R
O
true false
At minimum one Day of Week must be chosen.
Thur
R
O
true false
At minimum one Day of Week must be chosen.
Fri
R
O
true false
At minimum one Day of Week must be chosen.
Sat
R
O
true false
At minimum one Day of Week must be chosen.
Sun
R
O
true false
At minimum one Day of Week must be chosen.
Removal
O
true false
If not specified, false is assumed.
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
StayRequirements
5
O
O
Stay requirements should be provided only when the minimum or maximum stay is an exception to the normal stay requirements of a property.
This is optional for properties subscribing to the GDS content update service – however, if one or more are supplied then at least one must have a Start date in the future.
StayRequirement
6
R
R
There can be multiple stay requirements as long as the dates do not overlap.
Start
R
R
2024-10-01
Date
Effective date on which the stay requirements first take effect
End
R
R
2030-12-31
Date
Last date on which the stay requirements apply
Mon
R
R
true false
Days of week that the stay requirement is active. At least one must be set to “true”.
Tue
R
R
true false
Weds
R
R
true false
Thur
R
R
true false
Fri
R
R
true false
Sat
R
R
true false
Sun
R
R
true false
MinLOS
R
R
2
Integer
Minimum length of stay
MaxLOS
O
O
7
Integer
Maximum length of stay
- optional
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
ExtraPersonCharges
5
O
O
This defines the extra person, rollaway and crib charges applied to room- rates. These are transmitted to the GDSs as fixed or free form text areas of the property description (i.e. for information purposes only). If not supplied for properties subscribing to the GDS content update service then it will be assumed there are no extra charges.
Adult
6
O
O
20.00
Charge amount
Extra adult charge
Child
6
O
O
5.00
Charge amount
Extra child charge
AdultRollaway
6
O
O
10.00
Charge amount
Adult rollaway charge
ChildRollaway
6
O
O
0
Charge amount
Child rollaway charge
Crib
6
O
O
0
Charge amount
Crib/cot charge
ChildPolicyExtended
5
O
O
Used to extend the child policy information defined in: HotelDescriptiveContent/Policies/Policy/PolicyInfo
FreeChildCount
O
O
1
Integer
Number of free children for each RoomCompanionCount
MaxFreeChildCount
O
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).
RoomCompanionCount
O
O
2
Integer
Required number of accompanying guests in the room for the free child policy to apply
RoomCompanionType
O
O
PayingGuest
Values:
“PayingGuest” or
“Adult”
Type of accompanying guest. Note: “PayingGuest” may include chargeable children
MultimediaObjects
5
O
ONLY used by Suppliers that do not utilize ICE Portal or Leonardo as their image provider. This section provides additional information associated with the images provided in the MultimediaObjects elements (section 4.2.6)
MultimediaObject
6
R
ContentData
R
A
Should match the ContentData from the MultimediaObjects (4.2.6)
The type of content the supplier will provide.
Only ContentData =“A” will be allowed.
ContentID
R
Room001
Should match the ContentID from the MultimediaObjects (4.2.6)
Unique Indicator to tie back to the Property data.
FileCreatedDate
2023-01-01
yyyy-mm-dd
Date that the image was first loaded into the suppliers database
FileModifiedDate
2024-10-01
yyyy-mm-dd
Date that the image was last modified in the suppliers database
ParagraphNumber
R
3
Should match the Paragraph Number from the MultimediaObjects (4.2.6)
This will represent the order of the images in ascending order by number beginning with 1.
The number 1 will equate to the first picture (link) that is pulled for displayed.
thumbNailURL
O
Thumbnail image URL
RoomTypes
7
O
Only 1 element allowed per MultimediaObject.
Used to define the specific room type codes that the image is associated to.
RoomType
8
R
Required when RoomTypes is present.
Can be more that 1 room type.
RoomTypeCode
R
A1K
Room Type Code that this image is associated to.
Schema design view
Example transaction
GDS information
Although OpenTravel allows unlimited occurrences of each element within the OTA_HotelDescriptiveContentNotifRQ message, RateGain has elected to set limits for many of these
elements. Unless specified under the Usage column below, RateGain only allows one instance of each element per property message.
Level 1 & 2 elements and attributes are addressed in section.
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
GDS_Info
3
O
Only 1 element allowed per Property message.
GDS_Codes
4
R
Required when GDS_Info is present.
Only 1 element allowed per Property message.
GDS_Code
5
R
Only 1 element allowed per Property message.
Element
Level
Attribute
R O C
G D S
Example
Usage
Description
ChainCode
R
R
ZZ
2 Char
GDS Chain Code
Required for GDS_Code element.
GDS_Property Code
R
R
ZZ1234
6 Char
GDS Property Id
Required for GDS_Code element.
GDS_Name
R
R
Amadeus ApolloGalileo Sabre Worldspan
Name of the GDS System.
Enumerated attributed. Must use one of the values found in the Usage column.
Schema design view
Example transaction
Response message
The following sections describe in detail the message structure returned from the HCD XML Update Interface.
The payload for transactions returned by RateGain will follow the schema defined for the OTA_HotelDescriptiveContentNotifRS message.
Element
Level
Attribute
R O C
Example
Usage
Description
OTA_HotelDescriptiveContentnotifRS
0
R
Version
R
4.000
Version 4.000 should always be used.
Required for OTA_HotelDescriptiveCo ntentnotifRS element.
PrimaryLangID
R
EN
Refer to the Appendix B for valid codes
Mimic the ID found in the inbound XML message.
Success
1
C
Either a Success or a Success with Warnings can be present in the response.
If a Success Element is present, the property message was successfully submitted into HCD.
Warnings
1
C
Warning
2
C
Will be present if an Warnings element is present
Element
Level
Attribute
R O C
Example
Usage
Description
Type
R
3
Refer to the Appendix for valid codes
Due to limited warning types, this code can be a RateGain generated code.
ShortText
R
Invalid Property would result from update.
64 Char
A short description of the error
Required for Warning element.
Code
O
3
Refer to the Appendix for valid codes
Due to limited warning types, this code can be a RateGain generated code.
Errors
1
C
Either a Success or an Errors element will be present in the response
Error
2
C
Will be present if an Errors element is present
Type
R
3
Refer to the Appendix for valid codes
Due to limited warning types, this code can be a RateGain generated code.
ShortText
R
Invalid Property would result from update.
64 Char
A short description of the error
Required for Error element.
Code
O
3
Refer to the Appendix for valid codes
Due to limited error types, this code can be a RateGain generated code.
UniqueID
1
R
ID
R
RecordID00 1
32 Char
Mimic the MessageID within the inbound XML message. The ID will be appended with a sequence number.
Type
R
1
Always displays as 1.
Unique ID Type (UIT)
Required for UniqueID element.
Schema design view
Example transaction
The following is a standard Success response.
The following is a Success message with Warnings (non-fatal for HCD content load).
Note: some warnings may PREVENT content from PUSHING to the GDSs.
Below are sample standard Error responses (fatal for HCD load).
Appendix a – codes list
Code List Name
List
Countries & States (with Currencies & Country Access Codes)
Spoken Languages
Credit Cards
Errors & Warnings
Appendix b – supported language codes
The following languages are supported in HCD today. RateGain will announce when additional languages are added.
Supported Language Codes
Code
Language
EN
English
FR
French
DE
German
ES
Spanish (Castillian)
IT
Italian
NL
Dutch
ZH
Chinese (Simplified)
JA
Japanese
PT
Portuguese (Brazilian)
RU
Russian
Appendix c – client application generation using WSDL tools
One of the benefits of using web services and WSDL files is to allow clients to use tools to assist in generating code to communicate with these services. The challenge has been for these tools to catch up and be able to understand the complex and lengthy schema definitions that are used by the WSSE, OTA, and EB groups. The following
sections are meant to serve as a guide and Reference Implementation of tools known to work with both these schema sets, and RateGain’ web services.
Client Generation for Java
1. To generate client code in Java, RateGain recommends the use of the Apache Axis2 web services engine available at http://ws.apache.org/axis2. Version 1.4 has been tested and verified against the HCD XML Update Interface, but later releases are assumed to be backward compatible. Following are steps to build a client in Java using Axis2 1.4. The steps were executed on a Solaris UNIX system, but similar steps can be run on a Windows environment as well.Download and install Apache Axis2 version 1.4 from the above URL.
2. Download the wsdl file from: https://webservices-uatprod.rategain.com/OTAHotelDescriptiveContentNotif/web_services?WSDL
3. Download all required xsd files from: https://webservices-uatprod.rategain.com/OTAHotelDescriptiveContentNotif/
4. The WSDL and schema files should be placed in the same directory.
5. Set the environment variable AXIS2_HOME to the directory where Axis2 was installed. In this example,
/usr/local/axis2-1.4
6. Set the environment variable JAVA_HOME to the directory where Java is installed on the system. In this example, /usr/java1.6
7. Generate the client source code from the WSDL and schemas by executing the following command:
$AXIS2_HOME/bin/wsdl2java.sh -uri HotelDescriptiveContentNotifWS.wsdl -p com.pegs.webservices -d xmlbeans -s -o generated
This will read the web service definition from the “HotelDescriptiveContentNotifWS.wsdl” file, put all generated source code in the “generated” directory, use the xmlbeans databinding API, and create the service stub file in the com.pegs.webservices package. This step takes some time to complete, on the order of 10 minutes.
Note that if the WSDL was downloaded from the location listed above, this is the production location of the web service, and transactions sent to this end point will only be successful if the client has been implemented in production. The end point can be updated in the WSDL file manually prior to generating the source code to a different location that the client has access to.
8. The wsdl2java.sh script generates a build.xml file for using Ant to compile the source code it creates. This file will be in the output directory defined above, in this case, the “generated” directory.
9. Generate a client class that implements your business logic, placing it in the following directory:
generated/src/com/pegs/webservices
RateGain will supply example code that constructs the appropriate objects and sends a message to the web service if this is desired. Please contact your Service Manager for details.
10. Compile the source code using Ant. From the “generated” directory, execute the following command to compile and JAR a client application:
ant jar.client
The client jar file will be placed in this directory:
generated/build/lib
If the RateGain sample client code was used as the business logic, execute a request to the web service using the following command:
java –cp classpath com.pegs.webservices.Client
The classpath must include all Axis2 jar files, as well as the jar file created by the compilation step.
Last updated