Upload
vulien
View
225
Download
5
Embed Size (px)
Citation preview
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 1
Developer Advisory
Hotel Commission Information Messaging Products - OTA XML HotelAvail
Developer Advisory Number: 198
Version: 01
Load To Production: 24-Jul-12 05:00 EST 09:00 GMT
High Level Description:
Allow Hotel Suppliers the ability to return new Hotel Commission information in the Availability Message and return that information to OTA XML users.
Impact Summary: No Screen Changes
New OTA XML Schema elements
Reason For Issue: First notification
Customer Impact:
Internal Only
Developers
Agency Customers
Airline Customers
eCommerce Customers
Car, Hotel, Rail or Cruise Customers
System:
Galileo
Apollo
Worldspan
Load To Copy: Available now
Web Services: (API and Messaging) OTA XML
Issue History: Version 01
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 2
Overview
This Advisory will address the element changes for the OTA XML OTA_HotelAvailRS message.
Customer Benefit
Supplier can return commission information
Agent can receive commission information
Detail and Customer Examples
OTA XML Hotel Availability Agent Response - OTA_HotelAvailRS All charges are highlighted below
xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns="http://www.opentravel.org/OTA_RS/2003/05"
targetNamespace="http://www.opentravel.org/OTA_RS/2003/05"
elementFormDefault="qualified" version="3.001" id="OTA2006A">
- <xs:annotation>
<xs:documentation xml:lang="en">All Schema files in the OTA specification are made
available according to the terms defined by the OTA License Agreement at
http://www.opentravel.org/ota_downloads_form.cfm</xs:documentation> </xs:annotation>
- <xs:element name="OTA_HotelAvailRS">
- <xs:annotation>
<xs:documentation xml:lang="en">Returns information about hotel properties that
meet the requested criteria, indicating whether the requested service, rate, room
stay, etc. is available within the date(s) specified. The response message may
include Warnings from business processing rules, or Errors if the request did not
succeed.</xs:documentation> </xs:annotation>
- <xs:complexType>
- <xs:sequence>
- <xs:choice>
- <xs:sequence>
<xs:element name="Success" type="SuccessType" />
<xs:element name="Warnings" type="WarningsType" minOccurs="0" />
- <xs:element name="RoomStays" minOccurs="0">
- <xs:complexType>
- <xs:sequence>
- <xs:element name="RoomStay" maxOccurs="unbounded">
- <xs:annotation>
<xs:documentation xml:lang="en">Details on the Room Stay including Guest Counts,
Time Span of this Room Stay, and financial information related to the Room Stay,
including Guarantee, Deposit and Payment and Cancellation
Penalties.</xs:documentation>
</xs:annotation>
- <xs:complexType>
- <xs:complexContent>
<xs:extension base="RoomStayType" />
</xs:complexContent>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 3
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="Services" type="ServicesType" minOccurs="0" />
<xs:element name="Areas" type="AreasType" minOccurs="0" />
- <xs:element name="Criteria" minOccurs="0">
- <xs:complexType>
- <xs:sequence>
<xs:element name="Criterion" type="HotelSearchCriterionType"
maxOccurs="unbounded" /> </xs:sequence>
</xs:complexType>
</xs:element>
<xs:element ref="TPA_Extensions" minOccurs="0" />
</xs:sequence>
<xs:element name="Errors" type="ErrorsType" />
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="OTA_PayloadStdAttributes" />
</xs:complexType>
</xs:element>
- <!-- OTA_Profile.xsd
-->
- <!-- OTA_AirPreferences.xsd
-->
- <!-- OTA_HotelPreferences.xsd
-->
- <!-- OTA_HotelReservation.xsd
-->
- <xs:complexType name="ResCommonDetailType">
- <xs:annotation>
<xs:documentation xml:lang="en">A grouping of elements including Guest Counts,
Time Span, pointers to Res Guests, guest Memberships, Comments and Special
Requests and finally finacial information including Guarantee, Deposit and
Payyment and Cancellation Penalties.</xs:documentation> </xs:annotation>
- <xs:sequence>
- <xs:element name="Comments" type="CommentType" minOccurs="0">
- <xs:annotation>
<xs:documentation xml:lang="en">A collection of Comment objects. Comments which
apply to the whole Reservation or a particular Room Stay or
Service.</xs:documentation>
</xs:annotation>
</xs:element>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 4
</xs:sequence>
</xs:complexType>
- <xs:complexType name="ServicesType">
- <xs:annotation>
<xs:documentation xml:lang="en">A collection of Service objects. This is the collection
of all services associated with any part of this reservation (the reservation in its
entirety, one or more guests, or one or more room stays). Which services are
attributable to which part is determined by each object's ServiceRPHs
collection.</xs:documentation> </xs:annotation>
- <xs:sequence>
- <xs:element name="Service" maxOccurs="unbounded">
- <xs:annotation>
<xs:documentation xml:lang="en">A Service object represents a non-room product
provided to guests. Service products may have associated inventory and
charges.</xs:documentation>
</xs:annotation>
- <xs:complexType>
- <xs:sequence>
- <xs:element name="Price" type="AmountType" minOccurs="0">
- <xs:annotation>
<xs:documentation xml:lang="en">The selling price of this Service.</xs:documentation>
</xs:annotation>
</xs:element>
- <xs:element name="ServiceDetails" type="ResCommonDetailType" minOccurs="0">
- <xs:annotation>
<xs:documentation xml:lang="en">Details on the Service including Guest Counts, Time
Span of this Service, pointers to Res Guests, guest Memberships, Comments and
Special Requests pertaining to this particular Service and finally financial
information related to the Service, including Guarantee, Deposit and Payment and
Cancellation Penalties.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
- <!-- OTA_HotelCommonTypes.xsd
-->
- <xs:complexType name="AdditionalGuestAmountType">
- <xs:annotation>
<xs:documentation xml:lang="en">Charges related to additional
guests.</xs:documentation>
</xs:annotation>
- <xs:sequence>
- <xs:element name="Amount" type="TotalType">
- <xs:annotation>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 5
<xs:documentation xml:lang="en">The amount charged for an additional
guest.</xs:documentation> </xs:annotation>
</xs:element>
</xs:sequence>
<xs:attributeGroup ref="AgeQualifyingGroup" />
</xs:complexType>
- <xs:complexType name="AmountPercentType">
- <xs:annotation>
<xs:documentation xml:lang="en">Defines the percentage basis for calculating the fee
amount or the amount .</xs:documentation> </xs:annotation>
- <xs:attribute name="NmbrOfNights" type="xs:nonNegativeInteger" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">The number of nights of the hotel stay that are used
to calculate the fee amount.</xs:documentation> </xs:annotation>
</xs:attribute>
- <xs:attribute name="Percent" type="Percentage" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">The percentage used to calculate the
amount.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attributeGroup ref="CurrencyAmountGroup" />
</xs:complexType>
- <xs:complexType name="AmountType">
- <xs:annotation>
<xs:documentation xml:lang="en">Base charge and additional charges related to a
room that includes such things as additional guest amounts, cancel fees, etc. Also
includes Discount percentages, total amount, and the rate
description.</xs:documentation> </xs:annotation>
- <xs:sequence>
- <xs:element name="Base" type="TotalType" minOccurs="0">
- <xs:annotation>
<xs:documentation xml:lang="en">The base amount charged for the accommodation or
service per unit of time (ex: Nightly, Weekly, etc). If TaxInclusive is set to True,
then taxes are included in the base amount. Note that any additional charges
should itemized in the other elements.</xs:documentation> </xs:annotation>
</xs:element>
- <xs:element name="AdditionalGuestAmounts" minOccurs="0">
- <xs:annotation>
<xs:documentation xml:lang="en">A collection of charges that apply to for additional
occupants, guests or service users (over and above the rate's MaxGuest
Applicable)</xs:documentation>
</xs:annotation>
- <xs:complexType>
- <xs:sequence>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 6
- <xs:element name="AdditionalGuestAmount" type="AdditionalGuestAmountType"
maxOccurs="unbounded"> - <xs:annotation>
<xs:documentation xml:lang="en">Collection of incremental charges per age qualifying
code for additional guests. Amount charged for additional occupant is with respect
to age group of the base guests.</xs:documentation> </xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
- <xs:element name="CancelPolicies" type="CancelPenaltiesType" minOccurs="0">
- <xs:annotation>
<xs:documentation xml:lang="en">A collection of Cancellation
Policies</xs:documentation> </xs:annotation>
</xs:element>
- <xs:element name="RateDescription" type="ParagraphType" minOccurs="0">
- <xs:annotation>
<xs:documentation xml:lang="en">Description of the rate associated with the various
monetary amounts and policies.</xs:documentation> </xs:annotation>
</xs:element>
- <xs:element name="AdditionalCharges" minOccurs="0">
- <xs:annotation>
<xs:documentation xml:lang="en">Collection of additional charges.</xs:documentation>
</xs:annotation>
- <xs:complexType>
- <xs:sequence>
- <xs:element name="AdditionalCharge" maxOccurs="99">
- <xs:annotation>
<xs:documentation xml:lang="en">Amenities or services to which a charge
applies.</xs:documentation> </xs:annotation>
- <xs:complexType>
- <xs:sequence>
- <xs:element name="Amount" type="TotalType" minOccurs="0">
- <xs:annotation>
<xs:documentation xml:lang="en">The amount charged for an amenity or
service.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
- <xs:attribute name="RoomAmenityCode" type="OTA_CodeType" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">Identifes the types of room amenities to which a
charge applies. Refer to OTA Code List Room Amenity Type
(RMA).</xs:documentation> </xs:annotation>
</xs:attribute>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 7
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
- <xs:attribute name="MaxGuestApplicable" type="xs:positiveInteger" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">Indicates the maximum number of guests at this
rate.</xs:documentation>
</xs:annotation>
</xs:attribute>
- <xs:attribute name="MinLOS" type="xs:nonNegativeInteger" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">Indicates the minimum length of
stay.</xs:documentation> </xs:annotation>
</xs:attribute>
</xs:complexType>
- <xs:complexType name="AreasType">
- <xs:annotation>
<xs:documentation xml:lang="en">Defines an area determined by the hotel reservation
system.</xs:documentation> </xs:annotation>
- <xs:sequence>
- <xs:element name="Area" maxOccurs="99">
- <xs:annotation>
<xs:documentation xml:lang="en">An area determined by the hotel reservation
system.</xs:documentation> </xs:annotation>
- <xs:complexType>
- <xs:sequence>
<xs:element name="AreaDescription" type="ParagraphType" minOccurs="0" />
</xs:sequence>
- <xs:attribute name="CityCode" type="StringLength1to8" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">The IATA city code; for example DCA,
ORD.</xs:documentation> </xs:annotation>
</xs:attribute>
- <xs:attribute name="StateProvCode" type="StateProvCodeType" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">The standard code or abbreviation for the state,
province, or region.</xs:documentation> </xs:annotation>
</xs:attribute>
- <xs:attribute name="CountryCode" type="ISO3166" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">The country in which the area is
located.</xs:documentation>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 8
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
- <xs:complexType name="CancelPenaltiesType">
- <xs:annotation>
<xs:documentation xml:lang="en">A collection of CancelPenalty.</xs:documentation>
</xs:annotation>
- <xs:sequence>
- <xs:element name="CancelPenalty" type="CancelPenaltyType" minOccurs="0"
maxOccurs="unbounded"> - <xs:annotation>
<xs:documentation xml:lang="en">Defines the cancellation penalty of the hotel
facility.</xs:documentation> </xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
- <xs:complexType name="CancelPenaltyType">
- <xs:annotation>
<xs:documentation xml:lang="en">The CancelPenalty class defines the cancellation
policy of the hotel facility.</xs:documentation>
</xs:annotation>
- <xs:sequence>
- <xs:element name="Deadline" minOccurs="0">
- <xs:annotation>
<xs:documentation xml:lang="en">Cancellation deadline, absolute or
relative.</xs:documentation> </xs:annotation>
- <xs:complexType>
<xs:attributeGroup ref="DeadlineGroup" />
</xs:complexType>
</xs:element>
- <xs:element name="PenaltyDescription" type="ParagraphType" minOccurs="0"
maxOccurs="9"> - <xs:annotation>
<xs:documentation xml:lang="en">Text description of the Penalty in a given
language.</xs:documentation> </xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
- <xs:complexType name="CommentType">
- <xs:annotation>
<xs:documentation xml:lang="en">A collection of Comment objects. Comments which
apply to any part of the reservation (the reservation in its entirety, one or more
guests, one or more services, or one or more roomstays). Which comments apply
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 9
to which part is determined by each object's ResCommentsRPHs
collection.</xs:documentation>
</xs:annotation>
- <xs:sequence>
- <xs:element name="Comment" maxOccurs="unbounded">
- <xs:annotation>
<xs:documentation xml:lang="en">ResComment : The ResComment object is used to
store a further information (comments) pertaining to a reservation. Comments
appended to the reservation may be retained as the reservation passes through
multiple channels.</xs:documentation> </xs:annotation>
- <xs:complexType>
- <xs:complexContent>
<xs:extension base="ParagraphType" />
</xs:complexContent>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
- <xs:complexType name="GuaranteeType">
- <xs:annotation>
<xs:documentation xml:lang="en">The guarantee information to hold a
reservation</xs:documentation> </xs:annotation>
- <xs:attribute name="GuaranteeType" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">GuaranteeType : GuaranteeType An enumerated
type defining the guarantee to be applied to this reservation.</xs:documentation> </xs:annotation>
- <xs:simpleType>
- <xs:restriction base="StringLength1to32">
<xs:enumeration value="GuaranteeRequired" />
<xs:enumeration value="None" />
<xs:enumeration value="CC/DC/Voucher" />
<xs:enumeration value="Profile" />
<xs:enumeration value="Deposit" />
- <xs:enumeration value="PrePay">
- <xs:annotation>
<xs:documentation xml:lang="en">Indicates prepayment, typically this means payment
is required at booking.</xs:documentation> </xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
- <xs:attribute name="HoldTime" type="xs:time" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">The room will held up until this time without a
guarantee.</xs:documentation>
</xs:annotation>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 10
</xs:attribute>
</xs:complexType>
- <xs:complexType name="GuestCountType">
- <xs:annotation>
<xs:documentation xml:lang="en">A collection of GuestCount by age
group.</xs:documentation> </xs:annotation>
- <xs:sequence>
- <xs:element name="GuestCount" maxOccurs="99">
- <xs:annotation>
<xs:documentation xml:lang="en">A recurring element that identifies the number of
guests and ages of the guests in the request that determines the rates based on
business rules for occupancy at each property.</xs:documentation> </xs:annotation>
- <xs:complexType>
<xs:attributeGroup ref="GuestCountGroup" />
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
- <xs:complexType name="HotelSearchCriterionType">
- <xs:annotation>
<xs:documentation xml:lang="en">A collection of Profile objects or Unique IDs of
Profiles.</xs:documentation> </xs:annotation>
- <xs:complexContent>
- <xs:extension base="ItemSearchCriterionType">
- <xs:sequence>
- <xs:element name="StayDateRange" type="DateTimeSpanType" minOccurs="0">
- <xs:annotation>
<xs:documentation xml:lang="en">Range of dates, or fixed set of dates for Availability
Request. Date range can also be specified by using start dates and number of
nights (minimum, maximum or fixed).</xs:documentation> </xs:annotation>
</xs:element>
- <xs:element name="RoomStayCandidates" minOccurs="0">
- <xs:annotation>
<xs:documentation xml:lang="en">Collection of room stay
candidates.</xs:documentation>
</xs:annotation>
- <xs:complexType>
- <xs:sequence>
- <xs:element name="RoomStayCandidate" type="RoomStayCandidateType"
maxOccurs="unbounded"> - <xs:annotation>
<xs:documentation xml:lang="en">Element used to identify available room
products.</xs:documentation> </xs:annotation>
</xs:element>
</xs:sequence>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 11
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
- <xs:complexType name="RatePlanType">
- <xs:annotation>
<xs:documentation xml:lang="en">Combination of the rate plan core type and rate plan
additional information to define the details of the rate plan.</xs:documentation>
<xs:documentation xml:lang="en">Policies and descriptions that apply to a rate
plan.</xs:documentation>
<xs:documentation xml:lang="en">Information significant to defining a rate
plan.</xs:documentation>
</xs:annotation>
- <xs:sequence minOccurs="0">
- <xs:element name="RatePlanInclusions" minOccurs="0">
- <xs:annotation>
<xs:documentation xml:lang="en">Defines charges that are included in this rate
plan.This element allows for future extension should there be a
need.</xs:documentation> </xs:annotation>
- <xs:complexType>
<xs:attribute name="TaxInclusive" type="xs:boolean" use="optional" />
</xs:complexType>
</xs:element>
- <xs:element name="MealsIncluded" minOccurs="0">
- <xs:annotation>
<xs:documentation xml:lang="en">Defines which meals are included with this rate
program.</xs:documentation> </xs:annotation>
- <xs:complexType>
- <xs:attributeGroup ref="MealsIncludedGroup">
- <xs:annotation>
<xs:documentation xml:lang="en">Defines which meals are included with this rate
program.</xs:documentation> </xs:annotation>
</xs:attributeGroup>
</xs:complexType>
</xs:element>
</xs:sequence>
- <xs:attribute name="RatePlanID" type="StringLength1to64" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">A text field used to provide a special ID code that is
associated with the rate and is required in the reservation request in order to
obtain the rate. Examples are a corporate ID number, a promotion code or a
membership number.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 12
- <xs:complexType name="RateType">
- <xs:annotation>
<xs:documentation xml:lang="en">Individual rate amount. This rate is valid for a range
of number of occupants and an occupant type.</xs:documentation>
</xs:annotation>
- <xs:sequence>
- <xs:element name="Rate" maxOccurs="unbounded">
- <xs:annotation>
<xs:documentation xml:lang="en">The Rate contains a collection of elements that
define the amount of the rate, associated fees, additional occupant amounts as
well as payment and cancellation policies. Taxes can be broken out or included
within the various amounts. A currency can be associated to each amount The
applicable period of the the rate are indicated by the effective dates. Restrictions
that may apply to that rate, such as the minimum or maximum length of stay,
stay-over dates (such as a Saturday night), min/max guests applicable for the
rate, and age group (ex Adult) are attributes of Rate. It indicates the number of
units that the quoted rate is based upon, as well as the TimeUnits type used that
the rate is based upon, e.g.: 3days at $100.00 per day.</xs:documentation> </xs:annotation>
- <xs:complexType>
- <xs:complexContent>
- <xs:extension base="AmountType">
- <xs:sequence>
<xs:element ref="TPA_Extensions" minOccurs="0" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
- <xs:complexType name="RequiredPaymentsType">
- <xs:annotation>
<xs:documentation xml:lang="en">A collection of required
payments.</xs:documentation> </xs:annotation>
- <xs:sequence>
- <xs:element name="GuaranteePayment" maxOccurs="unbounded">
- <xs:annotation>
<xs:documentation xml:lang="en">Used to define the deposit policy, guarantees policy,
and/or accepted forms of payment.</xs:documentation>
</xs:annotation>
- <xs:complexType>
- <xs:sequence>
- <xs:element name="AmountPercent" type="AmountPercentType" minOccurs="0">
- <xs:annotation>
<xs:documentation xml:lang="en">Payment expressed as a fixed amount, or a
percentage of/or room nights.</xs:documentation> </xs:annotation>
</xs:element>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 13
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
- <xs:complexType name="RoomRateType">
- <xs:annotation>
<xs:documentation xml:lang="en">Individual rate amount. This rate is valid for a range
of number of occupants and an occupant type.</xs:documentation>
</xs:annotation>
- <xs:sequence>
- <xs:element name="Rates" type="RateType">
- <xs:annotation>
<xs:documentation xml:lang="en">Individual rate amount. This rate is valid for a range
of number of occupants and an occupant type.</xs:documentation> </xs:annotation>
</xs:element>
- <xs:element name="Features" minOccurs="0">
- <xs:annotation>
<xs:documentation xml:lang="en">A collection of features that are made available as
part of this speciific room and this specifiic rate plan.</xs:documentation> </xs:annotation>
- <xs:complexType>
- <xs:sequence>
- <xs:element name="Feature" minOccurs="0" maxOccurs="99">
- <xs:annotation>
<xs:documentation xml:lang="en">Allows for the description of any features and/or
amenities that are made available as part of this specific room and this specifiic
rate plan, for example, large screen television, video/DVD player in room, room
service breakfast, and details about that breakfast.</xs:documentation> </xs:annotation>
- <xs:complexType>
- <xs:attribute name="RoomAmenity" type="OTA_CodeType" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">Refer to OTA Code List Room Amenity Type
(RMA).</xs:documentation> </xs:annotation>
</xs:attribute>
<xs:attribute name="Quantity" type="Numeric0to999" use="optional" />
- <xs:attribute name="RoomViewCode" type="OTA_CodeType" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">Specifies the type of view a room has. Refer to OTA
Code List Room View Type (RVT).</xs:documentation> </xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 14
- <xs:element name="Availability" minOccurs="0" maxOccurs="5">
- <xs:complexType>
- <xs:attribute name="AvailabilityStatus" type="RateIndicatorType" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">Availability status.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
- <xs:attribute name="BookingCode" type="StringLength1to16" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">This is used to indicate the item booked and is
primarily used to exchange information with GDSs.</xs:documentation>
</xs:annotation>
</xs:attribute>
- <xs:attribute name="RoomTypeCode" type="StringLength1to16">
- <xs:annotation>
<xs:documentation xml:lang="en">Specfic system room type code, ex: A1K, A1Q
etc.</xs:documentation> </xs:annotation>
</xs:attribute>
<xs:attributeGroup ref="RatePlanGroup" />
</xs:complexType>
- <xs:complexType name="RoomStayCandidateType">
- <xs:annotation>
<xs:documentation xml:lang="en">Used to identify available room
products.</xs:documentation> </xs:annotation>
- <xs:sequence>
<xs:element name="GuestCounts" type="GuestCountType" minOccurs="0" />
</xs:sequence>
</xs:complexType>
- <xs:complexType name="RoomStayType">
- <xs:annotation>
<xs:documentation xml:lang="en">Details on the Room Stay including Guest Counts,
Time Span of this Room Stay, pointers to Res Guests, guest Memberships,
Comments and Special Requests pertaining to this particular Room Stay and finally
finacial information related to the Room Stay, including Guarantee, Deposit and
Payment and Cancellation Penalties.</xs:documentation>
</xs:annotation>
- <xs:sequence>
- <xs:element name="RatePlans" minOccurs="0">
- <xs:annotation>
<xs:documentation xml:lang="en">A collection of Rate Plans associated with a
particular Room Stay.</xs:documentation> <xs:documentation xml:lang="en">The rate plan element is used to contain all the rate
information for a single Rate Plan Code (ex RACK) for a given date range. A given
Rate Plan may have variable rates, over the effective period of the Rate Plan, this
is represented by the child element Rates.</xs:documentation>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 15
</xs:annotation>
- <xs:complexType>
- <xs:sequence>
<xs:element name="RatePlan" type="RatePlanType" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
</xs:element>
- <xs:element name="RoomRates" minOccurs="0">
- <xs:annotation>
<xs:documentation xml:lang="en">A collection of Room Rates associated with a
particular Room Stay. Each Room Rate combination can have multiple rates.
Example King room, Rack rate plan, Monday through Thursday, weekday amount,
Friday and Saturday, weekend amount.</xs:documentation> <xs:documentation xml:lang="en">The combination of a given Rate Plan and Room
Type. This allows for support for systems where Rate Plans are child of Room Type
as well as systems which Room Types are child of Rate Plans.</xs:documentation> </xs:annotation>
- <xs:complexType>
- <xs:sequence>
<xs:element name="RoomRate" type="RoomRateType" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
</xs:element>
- <xs:element name="Guarantee" type="GuaranteeType" minOccurs="0" maxOccurs="5">
- <xs:annotation>
<xs:documentation xml:lang="en">The guarantee information associated to the Room
Stay. A maximum of 5 occurances are available for use depending on the
context.</xs:documentation> </xs:annotation>
</xs:element>
- <xs:element name="DepositPayments" type="RequiredPaymentsType" minOccurs="0">
- <xs:annotation>
<xs:documentation xml:lang="en">A collection of deposit and/or payments for the
Room Stay.</xs:documentation> </xs:annotation>
</xs:element>
- <xs:element name="Total" type="TotalType" minOccurs="0">
- <xs:annotation>
<xs:documentation xml:lang="en">The total amount charged for the Room Stay
including additional occupant amounts and fees. If TaxInclusive is set to True,
then taxes are included in the total amount.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
- <xs:attributeGroup name="AgeQualifyingGroup">
- <xs:annotation>
<xs:documentation xml:lang="en">Base age group of occupants for which this rate is
valid (ex Adult).</xs:documentation>
</xs:annotation>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 16
- <xs:attribute name="AgeQualifyingCode" type="OTA_CodeType" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">Defines an age range or age category of a guest
(e.g., under 21, over 65, teen, infant). Refer to OTA Code List Age Qualifying Code
(AQC).</xs:documentation> </xs:annotation>
</xs:attribute>
</xs:attributeGroup>
- <xs:attributeGroup name="GuestCountGroup">
- <xs:annotation>
<xs:documentation xml:lang="en">Defines the number of guests.</xs:documentation>
</xs:annotation>
- <xs:attribute name="AgeQualifyingCode" type="OTA_CodeType" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">A code representing a business rule that determines
the charges for a guest based upon age range (e.g. Adult, Child, Senior, Child With
Adult, Child Without Adult). This attribute allows for an increase in rate by
occupant class. Refer to OTA Code List Age Qualifying Code
(AQC).</xs:documentation> </xs:annotation>
</xs:attribute>
- <xs:attribute name="Count" type="Numeric1to999" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">The number of guests in one AgeQualifyingCode or
Count.</xs:documentation> </xs:annotation>
</xs:attribute>
</xs:attributeGroup>
- <xs:attributeGroup name="MealsIncludedGroup">
- <xs:annotation>
<xs:documentation>Used to identify meals that are included.</xs:documentation>
</xs:annotation>
- <xs:attribute name="Breakfast" type="xs:boolean" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">When true, indicates breakfast is
included.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
- <xs:attributeGroup name="RatePlanGroup">
- <xs:annotation>
<xs:documentation xml:lang="en">The RatePlanCode assigned by the receiving system
for the inventory item in response to a new rate plan notification.
(Implementation Notes: This would only be returned when the notification is of
type New and the sender is translating RatePlanCode values. On subsequent
transactions for this rate plan, the sender would populate the RatePlanCode
attribute with this value returned by the receiver.)</xs:documentation> </xs:annotation>
- <xs:attribute name="RatePlanType" type="OTA_CodeType" use="optional">
- <xs:annotation>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 17
<xs:documentation xml:lang="en">An enumerated type that allows the query to specify
a rate category type, and provides major categories for comparison across brands.
Refer to OTA Code List Rate Plan Type (RPT).</xs:documentation> </xs:annotation>
</xs:attribute>
</xs:attributeGroup>
- <xs:attributeGroup name="RestrictionStatusGroup">
- <xs:annotation>
<xs:documentation xml:lang="en">Describes the status of a restriction on a room
and/or rate.</xs:documentation> </xs:annotation>
<xs:attribute name="Status" type="AvailabilityStatusType" use="optional" />
</xs:attributeGroup>
- <xs:simpleType name="AvailabilityStatusType">
- <xs:annotation>
<xs:documentation xml:lang="en">Identifies the availability status of an
item.</xs:documentation>
</xs:annotation>
- <xs:restriction base="xs:NMTOKENS">
- <xs:enumeration value="Open">
- <xs:annotation>
<xs:documentation xml:lang="en">Inventory is available for sale.</xs:documentation>
</xs:annotation>
</xs:enumeration>
- <xs:enumeration value="Close">
- <xs:annotation>
<xs:documentation xml:lang="en">Inventory is not available for
sale.</xs:documentation> </xs:annotation>
</xs:enumeration>
- <xs:enumeration value="ClosedOnArrival">
- <xs:annotation>
<xs:documentation xml:lang="en">Inventory is not available for sale to arriving
guests.</xs:documentation> </xs:annotation>
</xs:enumeration>
- <xs:enumeration value="ClosedOnArrivalOnRequest">
- <xs:annotation>
<xs:documentation xml:lang="en">Inventory may not be available for sale to arriving
guests.</xs:documentation>
</xs:annotation>
</xs:enumeration>
- <xs:enumeration value="OnRequest">
- <xs:annotation>
<xs:documentation xml:lang="en">Inventory may be available.</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
- <!--
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 18
OTA_CommonPrefs.xsd
-->
- <!-- OTA_SimpleTypes.xsd
-->
- <xs:simpleType name="AlphaLength3">
- <xs:annotation>
<xs:documentation xml:lang="en">Used for Alphabetic Strings, length exactly
3</xs:documentation> </xs:annotation>
- <xs:restriction base="xs:string">
<xs:pattern value="[a-zA-Z]{3}" />
</xs:restriction>
</xs:simpleType>
- <xs:simpleType name="DateOrTimeOrDateTimeType">
- <xs:annotation>
<xs:documentation xml:lang="en">A construct to validate either a date or a time or a
dateTime value.</xs:documentation> </xs:annotation>
<xs:union memberTypes="xs:date xs:dateTime xs:time" />
</xs:simpleType>
- <xs:simpleType name="ISO3166">
- <xs:annotation>
<xs:documentation xml:lang="en">2 character country code as defined in
ISO3166.</xs:documentation> </xs:annotation>
- <xs:restriction base="xs:string">
<xs:pattern value="[a-zA-Z]{2}" />
</xs:restriction>
</xs:simpleType>
- <xs:simpleType name="Money">
- <xs:annotation>
<xs:documentation xml:lang="en">Used for amounts, max 3
decimals</xs:documentation> </xs:annotation>
- <xs:restriction base="xs:decimal">
<xs:fractionDigits value="3" />
</xs:restriction>
</xs:simpleType>
- <xs:simpleType name="Numeric0to999">
- <xs:annotation>
<xs:documentation xml:lang="en">Used for Numeric values, from 0 to 999
inclusive</xs:documentation>
</xs:annotation>
- <xs:restriction base="xs:integer">
<xs:minInclusive value="0" />
<xs:maxInclusive value="999" />
</xs:restriction>
</xs:simpleType>
- <xs:simpleType name="Numeric1to999">
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 19
- <xs:annotation>
<xs:documentation xml:lang="en">Used for Numeric values, from 1 to 999
inclusive.</xs:documentation> </xs:annotation>
- <xs:restriction base="xs:integer">
<xs:minInclusive value="1" />
<xs:maxInclusive value="999" />
</xs:restriction>
</xs:simpleType>
- <xs:simpleType name="OTA_CodeType">
- <xs:annotation>
<xs:documentation xml:lang="en">Used for codes in the OTA code tables. Possible
values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.</xs:documentation> </xs:annotation>
- <xs:restriction base="xs:string">
<xs:pattern value="[0-9A-Z]{1,3}(\.[A-Z]{3}(\.X){0,1}){0,1}" />
</xs:restriction>
</xs:simpleType>
- <xs:simpleType name="Percentage">
- <xs:annotation>
<xs:documentation xml:lang="en">Used for percentage values</xs:documentation>
</xs:annotation>
- <xs:restriction base="xs:decimal">
<xs:minInclusive value="0.01" />
<xs:maxInclusive value="100.00" />
</xs:restriction>
</xs:simpleType>
- <xs:simpleType name="RateIndicatorType">
- <xs:annotation>
<xs:documentation xml:lang="en">An enumerated type indicating special conditions
with the rate Valid values: ChangeDuringStay, MultipleNights, Exclusive,
OnRequest, LimitedAvailability.</xs:documentation>
</xs:annotation>
- <xs:restriction base="StringLength1to32">
<xs:enumeration value="ChangeDuringStay" />
<xs:enumeration value="MultipleNights" />
<xs:enumeration value="Exclusive" />
<xs:enumeration value="OnRequest" />
<xs:enumeration value="LimitedAvailability" />
<xs:enumeration value="AvailableForSale" />
<xs:enumeration value="ClosedOut" />
<xs:enumeration value="OtherAvailable" />
- <xs:enumeration value="UnableToProcess">
- <xs:annotation>
<xs:documentation xml:lang="en">Indicates an issue that precluded the ability to
provide the information.</xs:documentation> </xs:annotation>
</xs:enumeration>
<xs:enumeration value="NoAvailability" />
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 20
<xs:enumeration value="RoomTypeClosed" />
<xs:enumeration value="RatePlanClosed" />
<xs:enumeration value="LOS_Restricted" />
</xs:restriction>
</xs:simpleType>
- <xs:simpleType name="StateProvCodeType">
- <xs:annotation>
<xs:documentation xml:lang="en">The standard code or abbreviation for the state,
province, or region</xs:documentation>
</xs:annotation>
- <xs:restriction base="StringLength1to8">
<xs:minLength value="2" />
</xs:restriction>
</xs:simpleType>
- <xs:simpleType name="StringLength1to128">
- <xs:annotation>
<xs:documentation xml:lang="en">Used for Character Strings, length 1 to
128</xs:documentation> </xs:annotation>
- <xs:restriction base="xs:string">
<xs:minLength value="1" />
<xs:maxLength value="128" />
</xs:restriction>
</xs:simpleType>
- <xs:simpleType name="StringLength1to16">
- <xs:annotation>
<xs:documentation xml:lang="en">Used for Character Strings, length 1 to
16</xs:documentation> </xs:annotation>
- <xs:restriction base="xs:string">
<xs:minLength value="1" />
<xs:maxLength value="16" />
</xs:restriction>
</xs:simpleType>
- <xs:simpleType name="StringLength1to32">
- <xs:annotation>
<xs:documentation xml:lang="en">Used for Character Strings, length 1 to
32</xs:documentation> </xs:annotation>
- <xs:restriction base="xs:string">
<xs:minLength value="1" />
<xs:maxLength value="32" />
</xs:restriction>
</xs:simpleType>
- <xs:simpleType name="StringLength1to64">
- <xs:annotation>
<xs:documentation xml:lang="en">Used for Character Strings, length 1 to
64</xs:documentation> </xs:annotation>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 21
- <xs:restriction base="xs:string">
<xs:minLength value="1" />
<xs:maxLength value="64" />
</xs:restriction>
</xs:simpleType>
- <xs:simpleType name="StringLength1to8">
- <xs:annotation>
<xs:documentation xml:lang="en">Used for Character Strings, length 1 to
8</xs:documentation>
</xs:annotation>
- <xs:restriction base="xs:string">
<xs:minLength value="1" />
<xs:maxLength value="8" />
</xs:restriction>
</xs:simpleType>
- <xs:simpleType name="TimeOrDateTimeType">
- <xs:annotation>
<xs:documentation xml:lang="en">Allows for the specification of a date time or just
time.</xs:documentation> </xs:annotation>
<xs:union memberTypes="xs:dateTime xs:time" />
</xs:simpleType>
- <xs:simpleType name="TimeUnitType">
- <xs:annotation>
<xs:documentation xml:lang="en">An enumerated type defining the unit in which the
time is expressed.</xs:documentation> </xs:annotation>
- <xs:restriction base="StringLength1to16">
<xs:enumeration value="Year" />
<xs:enumeration value="Month" />
<xs:enumeration value="Week" />
<xs:enumeration value="Day" />
<xs:enumeration value="Hour" />
<xs:enumeration value="Second" />
<xs:enumeration value="FullDuration" />
</xs:restriction>
</xs:simpleType>
- <!-- OTA_VehicleCommonTypes.xsd
-->
- <!-- OTA_CommonTypes.xsd
-->
- <xs:element name="TPA_Extensions" type="TPA_Extensions_Type">
- <xs:annotation>
<xs:documentation xml:lang="en">A placeholder in the schema to allow for additional
elements and attributes to be included if required, per Trading Partner Agreement
(TPA).</xs:documentation> </xs:annotation>
</xs:element>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 22
- <xs:complexType name="DateTimeSpanType">
- <xs:annotation>
<xs:documentation xml:lang="en">Used to specify a time window range by either
specifying an earliest and latest date for the start date and end date or by giving a
date with a time period that can be applied before and/or after the start
date.</xs:documentation> </xs:annotation>
<xs:attributeGroup ref="DateTimeSpanGroup" />
</xs:complexType>
- <xs:complexType name="ErrorType">
- <xs:annotation>
<xs:documentation xml:lang="en">Standard way to indicate that an error occurred
during the processing of an OTA message</xs:documentation> </xs:annotation>
- <xs:simpleContent>
- <xs:extension base="FreeTextType">
- <xs:attribute name="Type" type="OTA_CodeType" use="required">
- <xs:annotation>
<xs:documentation xml:lang="en">The Error element MUST contain the Type attribute
that uses a recommended set of values to indicate the error type. The validating
XSD can expect to accept values that it has NOT been explicitly coded for and
process them by using Type ="Unknown". Refer to OTA Code List Error Warning
Type (EWT).</xs:documentation> </xs:annotation>
</xs:attribute>
<xs:attributeGroup ref="ErrorWarningAttributeGroup" />
</xs:extension>
</xs:simpleContent>
</xs:complexType>
- <xs:complexType name="ErrorsType">
- <xs:annotation>
<xs:documentation xml:lang="en">A collection of errors that occurred during the
processing of a message.</xs:documentation> </xs:annotation>
- <xs:sequence>
<xs:element name="Error" type="ErrorType" maxOccurs="99" />
</xs:sequence>
</xs:complexType>
- <xs:complexType name="FormattedTextTextType">
- <xs:annotation>
<xs:documentation xml:lang="en">Provides text and indicates whether it is formatted
or not.</xs:documentation>
</xs:annotation>
- <xs:simpleContent>
<xs:extension base="xs:string" />
</xs:simpleContent>
</xs:complexType>
- <xs:complexType name="FreeTextType">
- <xs:annotation>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 23
<xs:documentation xml:lang="en">Textual information to provide descriptions and/or
additional information.</xs:documentation> </xs:annotation>
- <xs:simpleContent>
<xs:extension base="xs:string" />
</xs:simpleContent>
</xs:complexType>
- <xs:complexType name="ItemSearchCriterionType">
- <xs:annotation>
<xs:documentation xml:lang="en">Identifies the criterion for a
search.</xs:documentation> </xs:annotation>
- <xs:sequence>
- <xs:element name="HotelRef" minOccurs="0">
- <xs:annotation>
<xs:documentation xml:lang="en">Indicates the detail of hotel reference
information.</xs:documentation> </xs:annotation>
- <xs:complexType>
<xs:attributeGroup ref="HotelReferenceGroup" />
- <xs:attribute name="SupplierIntegrationLevel" type="xs:nonNegativeInteger"
use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">The level of integration of a property to provide
automated transaction information. The lower the number, the higher the
integration (e.g., a 1 means the supplier has the highest level of integration
automation).</xs:documentation> </xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
- <xs:complexType name="ParagraphType">
- <xs:annotation>
<xs:documentation xml:lang="en">An indication of a new paragraph for a sub-section
of a formatted text message.</xs:documentation>
</xs:annotation>
- <xs:choice minOccurs="0" maxOccurs="3">
<xs:element name="Text" type="FormattedTextTextType" />
</xs:choice>
- <xs:attribute name="Name" type="StringLength1to64" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">In many cases the description repeats, this will
allow you to define the information that is being sent, typically used when multiple
occurrences of ParagraphType are being sent.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
- <xs:complexType name="SuccessType">
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 24
- <xs:annotation>
<xs:documentation xml:lang="en">Standard way to indicate successful processing of
an OTA message. Returning an empty element of this type indicates
success.</xs:documentation> </xs:annotation>
</xs:complexType>
- <xs:complexType name="TPA_Extensions_Type">
- <xs:annotation>
<xs:documentation xml:lang="en">Allows extensions to be added to the OTA
specification per trading partner agreement.</xs:documentation> </xs:annotation>
- <xs:sequence>
<xs:element name="CommissionRateInd" type="xs:string" minOccurs="0" />
<xs:documentation xml:lang="en">Commissionable indicator. Values are ‘Y’ if
commissionable, ‘N’ if not commissionable.</xs:documentation> <xs:element name="CommissionRatePercent" minOccurs="0" />
<xs:documentation xml:lang="en">Commission percentage. A 2 character field with no
decimal: 02 = 2%, 10 = 10%.</xs:documentation> </xs:sequence>
</xs:complexType>
- <xs:complexType name="TaxType">
- <xs:annotation>
<xs:documentation xml:lang="en">Applicable tax element. This element allows for both
percentages and flat amounts. If one field is used, the other should be zero since
logically, taxes should be calculated in only one of the two
ways.</xs:documentation>
</xs:annotation>
<xs:attributeGroup ref="FeeTaxGroup" />
</xs:complexType>
- <xs:complexType name="TaxesType">
- <xs:annotation>
<xs:documentation xml:lang="en">A collection of taxes.</xs:documentation>
</xs:annotation>
- <xs:sequence>
- <xs:element name="Tax" type="TaxType" minOccurs="0" maxOccurs="99">
- <xs:annotation>
<xs:documentation xml:lang="en">An individual tax.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
- <xs:complexType name="TotalType">
- <xs:annotation>
<xs:documentation xml:lang="en">The total amount charged for the service including
additional amounts and fees.</xs:documentation> </xs:annotation>
- <xs:sequence>
<xs:element name="Taxes" type="TaxesType" minOccurs="0" />
</xs:sequence>
<xs:attribute name="AmountBeforeTax" type="Money" use="optional" />
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 25
<xs:attribute name="AmountAfterTax" type="Money" use="optional" />
<xs:attributeGroup ref="CurrencyCodeGroup" />
</xs:complexType>
- <xs:complexType name="WarningType">
- <xs:annotation>
<xs:documentation xml:lang="en">Standard way to indicate successful processing of
an OTA message, but one in which warnings are generated</xs:documentation> </xs:annotation>
- <xs:simpleContent>
- <xs:extension base="FreeTextType">
- <xs:attribute name="Type" type="OTA_CodeType" use="required">
- <xs:annotation>
<xs:documentation xml:lang="en">The Warning element MUST contain the Type
attribute that uses a recommended set of values to indicate the warning type. The
validating XSD can expect to accept values that it has NOT been explicitly coded
for and process them by using Type ="Unknown". Refer to OTA Code List Error
Warning Type (EWT).</xs:documentation> </xs:annotation>
</xs:attribute>
<xs:attributeGroup ref="ErrorWarningAttributeGroup" />
</xs:extension>
</xs:simpleContent>
</xs:complexType>
- <xs:complexType name="WarningsType">
- <xs:sequence>
<xs:element name="Warning" type="WarningType" maxOccurs="99" />
</xs:sequence>
</xs:complexType>
- <xs:attributeGroup name="CurrencyAmountGroup">
- <xs:annotation>
<xs:documentation xml:lang="en">Provides a monetary amount and the currency code
to reflect the currency in which this amount is expressed.</xs:documentation>
</xs:annotation>
<xs:attribute name="Amount" type="Money" use="optional" />
</xs:attributeGroup>
- <xs:attributeGroup name="CurrencyCodeGroup">
- <xs:annotation>
<xs:documentation xml:lang="en">Provides a currency code to reflect the currency in
which an amount may be expressed.</xs:documentation>
</xs:annotation>
- <xs:attribute name="CurrencyCode" type="AlphaLength3" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">The code specifying a monetary unit. Use ISO 4217,
three alpha code.</xs:documentation> </xs:annotation>
</xs:attribute>
</xs:attributeGroup>
- <xs:attributeGroup name="DateTimeSpanGroup">
- <xs:annotation>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 26
<xs:documentation xml:lang="en">The attributes of the OTA DateTimeSpan data type
are based on the W3C base data types of timeInstant and timeDuration. The
lexical representation for timeDuration is the [ISO 8601] extended format PnYn
MnDTnH nMnS, where nY represents the number of years, nM the number of
months, nD the number of days, 'T' is the date/time separator, nH the number of
hours, nM the number of minutes and nS the number of seconds. The number of
seconds can include decimal digits to arbitrary precision. As an example, 7
months, 2 days, 2hours and 30 minutes would be expressed as
P0Y7M2DT2H30M0S. Truncated representations are allowed provided they
conform to ISO 8601 format.</xs:documentation> <xs:documentation xml:lang="en">Time periods, i.e. specific durations of time, can be
represented by supplying two items of information: a start instant and a duration
or a start instant and an end instant or an end instant and a duration. The OTA
standards use the XML mapping that provides for two elements to represent the
specific period of time; a startInstant and a duration.</xs:documentation> </xs:annotation>
- <xs:attribute name="Start" type="DateOrTimeOrDateTimeType" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">The starting value of the time
span.</xs:documentation>
</xs:annotation>
</xs:attribute>
- <xs:attribute name="End" type="DateOrTimeOrDateTimeType" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">The ending value of the time
span.</xs:documentation> </xs:annotation>
</xs:attribute>
</xs:attributeGroup>
- <xs:attributeGroup name="DeadlineGroup">
- <xs:annotation>
<xs:documentation xml:lang="en">The absolute deadline or amount of offset time
before a deadline for a payment of cancel goes into effect.</xs:documentation> </xs:annotation>
- <xs:attribute name="AbsoluteDeadline" type="TimeOrDateTimeType" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">Defines the absolute deadline. Either this or the
offset attributes may be used.</xs:documentation>
</xs:annotation>
</xs:attribute>
- <xs:attribute name="OffsetTimeUnit" type="TimeUnitType" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">The units of time, e.g.: days, hours, etc., that apply
to the deadline.</xs:documentation> </xs:annotation>
</xs:attribute>
- <xs:attribute name="OffsetUnitMultiplier" type="Numeric0to999" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">The number of units of
DeadlineTimeUnit.</xs:documentation>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 27
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
- <xs:attributeGroup name="ErrorWarningAttributeGroup">
- <xs:annotation>
<xs:documentation xml:lang="en">Used to identify an application error by either text,
code, or by an online description and also to give the status, tag, and/or
identification of the record that may have caused the error.</xs:documentation> </xs:annotation>
<xs:attribute name="ShortText" type="StringLength1to128" use="optional" />
- <xs:attribute name="Code" type="OTA_CodeType" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">If present, this refers to a table of coded values
exchanged between applications to identify errors or warnings. Refer to OTA Code
List Error Codes (ERR).</xs:documentation> </xs:annotation>
</xs:attribute>
</xs:attributeGroup>
- <xs:attributeGroup name="FeeTaxGroup">
- <xs:annotation>
<xs:documentation xml:lang="en">Defines the fees and/or taxes associated with a
charge (e.g. taxes associated with a hotel rate).</xs:documentation> </xs:annotation>
- <xs:attribute name="Percent" type="Percentage" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">Fee percentage; if zero, assume use of the Amount
attribute (Amount or Percent must be a zero value).</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
- <xs:attributeGroup name="HotelReferenceGroup">
- <xs:annotation>
<xs:documentation xml:lang="en">HotelReference: The hotel reference identifies a
specific hotel by using the Chain Code, the Brand Code, and the Hotel Code. The
codes used are agreed upon by trading partners.</xs:documentation> </xs:annotation>
- <xs:attribute name="ChainCode" type="StringLength1to8" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">The code that identifies a hotel chain or
management group. The hotel chain code is decided between vendors. This
attribute is optional if the hotel is an independent property that can be identified
by the HotelCode attribute.</xs:documentation> </xs:annotation>
</xs:attribute>
- <xs:attribute name="HotelCode" type="StringLength1to16" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">The code that uniquely identifies a single hotel
property. The hotel code is decided between vendors.</xs:documentation> </xs:annotation>
</xs:attribute>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 28
- <xs:attribute name="HotelName" type="StringLength1to128" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">A text field used to communicate the proper name
of the hotel.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:attributeGroup>
- <xs:attributeGroup name="OTA_PayloadStdAttributes">
- <xs:annotation>
<xs:documentation xml:lang="en">The OTA_PayloadStdAttributes defines the standard
attributes that appear on the root element for all OTA
payloads.</xs:documentation> </xs:annotation>
- <xs:attribute name="Version" type="xs:decimal" use="required">
- <xs:annotation>
<xs:documentation xml:lang="en">For all OTA versioned messages, the version of the
message is indicated by a decimal value.</xs:documentation>
</xs:annotation>
</xs:attribute>
- <xs:attribute name="TransactionIdentifier" type="StringLength1to32" use="optional">
- <xs:annotation>
<xs:documentation xml:lang="en">A unique identifier to relate all messages within a
transaction (e.g. this would be sent in all request and response messages that are
part of an on-going transaction).</xs:documentation> </xs:annotation>
</xs:attribute>
</xs:attributeGroup>
</xs:schema>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 29
Example use:
<OTA_HotelAvailRS Version="1" xmlns="http://www.opentravel.org/OTA_RS/2003/05"> <Success/> <RoomStays> <RoomStay> <RoomRates> <RoomRate BookingCode="Z100RACRAC"> <Rates> <Rate> <Base AmountBeforeTax="129.00" CurrencyCode="USD"/> <CancelPolicies> <CancelPenalty> <Deadline OffsetTimeUnit="Hour" OffsetUnitMultiplier="24"/> </CancelPenalty> </CancelPolicies> <RateDescription> <Text>2D NO SMOKING ACCESSIBLE ROOM WHEELCHAIR ACCESSIBLE</Text> </RateDescription> <TPA_Extensions> <CommissionRateInd>Y</CommissionRateInd> </TPA_Extensions> </Rate> </Rates> </RoomRate> </RoomRates> <Guarantee GuaranteeType="GuaranteeRequired"/> <Total> <Taxes> <Tax Percent="17.5"/> </Taxes> </Total> </RoomStay> <RoomStay> <RoomRates> <RoomRate BookingCode="Z200RACRAC"> <Rates> <Rate> <Base AmountBeforeTax="129.00" CurrencyCode="USD"/> <CancelPolicies> <CancelPenalty> <Deadline OffsetTimeUnit="Hour" OffsetUnitMultiplier="24"/> </CancelPenalty> </CancelPolicies> <RateDescription> <Text>2D NO SMOKING ACCESSIBLE ROOM WHEELCHAIR ACCESSIBLE</Text> </RateDescription> <TPA_Extensions> <CommissionRatePercent>15</CommissionRatePercent>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 30
</TPA_Extensions> </Rate> </Rates> </RoomRate> </RoomRates> <Guarantee GuaranteeType="GuaranteeRequired"/> <Total> <Taxes> <Tax Percent="17.5"/> </Taxes> </Total> </RoomStay> </RoomStays> <Services> <Service> <Price> <AdditionalGuestAmounts> <AdditionalGuestAmount AgeQualifyingCode="10"> <Amount AmountBeforeTax="10.00"/> </AdditionalGuestAmount> </AdditionalGuestAmounts> <AdditionalCharges> <AdditionalCharge RoomAmenityCode="131"> <Amount AmountBeforeTax="10.00"/> </AdditionalCharge> </AdditionalCharges> </Price> </Service> </Services> <Areas> <Area CountryCode="US" StateProvCode="AL"> <AreaDescription> <Text>MOUNTAIN BROOK</Text> </AreaDescription> </Area> </Areas> <Criteria> <Criterion> <HotelRef ChainCode="NZ" HotelCode="AL391" HotelName="THE HOTEL HIGHLAND A" SupplierIntegrationLevel="2"/> <StayDateRange End="2012-01-19" Start="2012-01-18"/> <RoomStayCandidates> <RoomStayCandidate> <GuestCounts> <GuestCount AgeQualifyingCode="10" Count="01"/> </GuestCounts> </RoomStayCandidate> </RoomStayCandidates> </Criterion> </Criteria> </OTA_HotelAvailRS>
Developer Advisory Hotel Commission Information Messaging Products - OTA XML HotelAvail
July 12, 2012 TRAVELPORT CONFIDENTIAL INFORMATION Page 31
Travelport provides this document for information purposes only and does not guarantee that the information contained in this
document is accurate, current or complete.
This document and the products listed herein are subject to change without notice.
© 2012 Travelport. All rights reserved. Travelport, the Travelport logo, Worldspan, Galileo and Apollo, as well as any Travelport product names referenced herein are trademarks and the property of Travelport.
Other trademarks are the property of their respective owners.