The OTA_ReadRQ scenarios result in the same OTA_ResRetrieveRS
response message.
<?xml version="1.0" encoding="utf-8"?>
<OTA_ResRetrieveRS EchoToken="Example123" PrimaryLangID="eng" Target="Production" TimeStamp="2018-07-29T07:38:54.729Z" Version="1.0">
<Success />
<ReservationsList>
<HotelReservation RoomStayReservation="true" CreateDateTime="2018-07-18T18:53:12" CreatorID="2" LastModifyDateTime="2018-07-18T18:53:12" LastModifierID="2" ResStatus="Book">
<UniqueID ID="600123456" Type="14" />
<RoomStays>
<RoomStay IndexNumber="796">
<RoomTypes>
<RoomType NumberOfUnits="1" RoomTypeCode="4">
<RoomDescription Name="Superior Double" />
</RoomType>
</RoomTypes>
<RoomRates>
<RoomRate RoomTypeCode="DBL" NumberOfUnits="1" RatePlanCode="STD">
<Rates>
<Rate EffectiveDate="2018-09-07">
<Base AmountBeforeTax="15100" AmountAfterTax="15100" DecimalPlaces="2" />
</Rate>
</Rates>
<Total AmountBeforeTax="15100" AmountAfterTax="15100" DecimalPlaces="2" />
</RoomRate>
<RoomRate RoomTypeCode="DBL" NumberOfUnits="1" RatePlanCode="STD">
<Rates>
<Rate EffectiveDate="2018-09-08">
<Base AmountBeforeTax="15600" AmountAfterTax="15600" DecimalPlaces="2" />
</Rate>
</Rates>
<Total AmountBeforeTax="15600" AmountAfterTax="15600" DecimalPlaces="2" />
</RoomRate>
<RoomRate RoomTypeCode="DBL" NumberOfUnits="1" RatePlanCode="STD">
<Rates>
<Rate EffectiveDate="2018-09-09">
<Base AmountBeforeTax="17600" AmountAfterTax="17600" DecimalPlaces="2" />
</Rate>
</Rates>
<Total AmountBeforeTax="17600" AmountAfterTax="17600" DecimalPlaces="2" />
</RoomRate>
</RoomRates>
<GuestCounts IsPerRoom="true">
<GuestCount AgeQualifyingCode="10" Count="2" />
</GuestCounts>
<TimeSpan Start="2018-09-07" End="2018-09-10" />
<CancelPenalties>
<CancelPenalty PolicyCode="4" NonRefundable="false">
<Deadline OffsetTimeUnit="Day" OffsetUnitMultiplier="15" OffsetDropTime="BeforeArrival" />
<AmountPercent BasisType="FullStay" Percent="100" />
<PenaltyDescription>
<Text>
<![CDATA[Booking can be cancelled until 15 day(s) before arrival.]]>
</Text>
</PenaltyDescription>
</CancelPenalty>
</CancelPenalties>
<Total AmountBeforeTax="56700" AmountAfterTax="56700" DecimalPlaces="2" />
<ResGuestRPHs>
<ResGuestRPH RPH="1" />
</ResGuestRPHs>
<ServiceRPHs>
<ServiceRPH RPH="1" />
</ServiceRPHs>
</RoomStay>
</RoomStays>
<Services>
<Service ServiceRPH="1" ServiceInventoryCode="1" ID="1103">
<Price NumberOfUnits="1">
<Base AmountAfterTax="1400" DecimalPlaces="2" />
</Price>
<ServiceDetails>
<GuestCounts>
<GuestCount Count="2" />
</GuestCounts>
<TimeSpan Start="2018-09-07" End="2018-09-10" />
<ServiceDescription>
<Text>
<![CDATA[Breakfast]]>
</Text>
</ServiceDescription>
</ServiceDetails>
<TPA_Extensions>
<ServiceExtension ServiceChargeType="6">
<SelectedDates>
<Date Value="2018-09-07" />
<Date Value="2018-09-08" />
<Date Value="2018-09-09" />
</SelectedDates>
</ServiceExtension>
</TPA_Extensions>
</Service>
</Services>
<ResGuests>
<ResGuest ResGuestRPH="1">
<Profiles>
<ProfileInfo>
<Profile ProfileType="1">
<Customer Gender="Unknown">
<PersonName>
<GivenName>John</GivenName>
<Surname>Doe</Surname>
</PersonName>
</Customer>
</Profile>
<UniqueID ID="1234" Type="21" />
</ProfileInfo>
</Profiles>
</ResGuest>
</ResGuests>
<ResGlobalInfo>
<TimeSpan Start="2018-09-07" End="2018-09-10" />
<Comments>
<Comment>
<Text>
<![CDATA[You have a booker that prefers communication by email All guests provided by the booking site: John Doe Total number of guests: 2 Total number of rooms: 1 ]]>
</Text>
</Comment>
</Comments>
<Guarantee GuaranteeType="CC/DC/Voucher">
<GuaranteesAccepted>
<GuaranteeAccepted GuaranteeTypeCode="5">
<PaymentCard CardCode="VI" ExpireDate="0918">
<CardHolderName>Card Holder Name</CardHolderName>
<CardNumber>
<PlainText>4111111111111111</PlainText>
</CardNumber>
</PaymentCard>
</GuaranteeAccepted>
</GuaranteesAccepted>
</Guarantee>
<Total AmountAfterTax="56700" DecimalPlaces="2" />
<HotelReservationIDs>
<HotelReservationID ResID_Type="5" ResID_Value="123456789" ResID_Source="2" ResID_SourceContext="Booking.com" />
<HotelReservationID ResID_Type="14" ResID_Value="600123456" />
</HotelReservationIDs>
<Profiles>
<ProfileInfo>
<Profile ProfileType="18">
<Customer Gender="Unknown">
<PersonName>
<GivenName>John</GivenName>
<Surname>Doe</Surname>
</PersonName>
<Telephone PhoneNumber="+31307820590" />
<Email>support@smarthotel.nl</Email>
<Address FormattedInd="false">
<AddressLine>Orteliuslaan 19</AddressLine>
<CityName>Utrecht</CityName>
<PostalCode>3528 BA</PostalCode>
<CountryName>NL</CountryName>
</Address>
</Customer>
</Profile>
<UniqueID ID="5678" Type="1" />
</ProfileInfo>
</Profiles>
<TotalCommissions>
<CommissionPayableAmount DecimalPlaces="2" Amount="10206" />
</TotalCommissions>
<BasicPropertyInfo HotelCode="12345" />
</ResGlobalInfo>
</HotelReservation>
</ReservationsList>
</OTA_ResRetrieveRS>
All elements that contain a textual value that is marked as "formatted text" in OTA standard is written as a CDATA section. All other elements, including elements containing a textual value that is not a formatted text that is not formatted text, are written as normal elements.
Element / @Attribute | Parent | Info | Values | Occurrence |
---|---|---|---|---|
ReservationsList | OTA_ResRetrieveRS | List of reservations. | 0..1 | |
HotelReservation | ReservationsList | One item in a list of hotel reservations. | 0..n | |
POS | HotelReservation | Identifies who made the original reservation. Point of Sale (POS) identifies the party or connection channel making the request. | 1 | |
Source | POS | This holds the details about the requestor. It may be repeated to also accommodate the delivery systems. Provides information on the source of a request. | 1 | |
BookingChannel | Source | Specifies the booking channel type and whether it is the primary means of connectivity of the source. | 1 | |
@Type | BookingChannel | The type of booking channel (e.g. Global Distribution System (GDS), Alternative Distribution System (ADS), Sales and Catering System (SCS), Property Management System (PMS), Central Reservation System (CRS), Tour Operator System (TOS), Internet and ALL). | Refer to OpenTravel Code List Booking Channel Type (BCT) | 1 |
CompanyName | BookingChannel | Identifies the company that is associated with the booking channel. Identifies a company by name. | [string] | 1 |
@RoomStayReservation | HotelReservation | true |
1 | |
@CreateDateTime | HotelReservation | Time stamp of the creation. | [yyyy-MM-ddTHH:mm:ss] | 1 |
@CreatorID | HotelReservation | The ID of the booking site. | Refer to Code List Creator ID | 0..1 |
@LastModifyDateTime | HotelReservation | Time stamp of last modification. | [yyyy-MM-ddTHH:mm:ss] | 1 |
@LastModifierID | HotelReservation | Identifies the last software system or person to modify a record. | [integer] | 0..1 |
@ResStatus | HotelReservation | Indicates the status of the reservation. | Book Cancel Modify |
1 |
UniqueID | HotelReservation | An identifier used to uniquely reference an object in a system. | 1 | |
@ID | UniqueID | Smarthotel reservation ID. | [integer] | 1 |
@Type | UniqueID | A reference to the type of object defined by the UniqueID element. | Refer to OpenTravel Code List Unique ID Type (UIT).14 = Reservation15 = Cancellation |
1 |
RoomStays | HotelReservation | Collection of room stays. | 1 | |
RoomStay | RoomStays | Details on the Room Stay. One RoomStays element can contain multiple RoomStay elements. | 1..n | |
@IndexNumber | RoomStay | Number of the room stay within the RoomStays collection. | [integer] | 1 |
RoomTypes | RoomStay | A collection of Room Types associated with a particular Room Stay. | 0..1 | |
RoomType | RoomTypes | Provides details regarding rooms. | 1 | |
@IsRoom | RoomType | Indicates whether the room type is a room (true ) or a bed type (false ). |
true false |
1 |
@BedTypeCode | RoomType | The ID of the bed type. | [integer] | 1 |
@NumberOfUnits | RoomType | The number of rooms that have been combined to create this room type. | 1 | 1 |
@RoomTypeCode | RoomType | The ID of the room. | [integer] | 1 |
RoomDescription | RoomType | Textual information regarding the room. | 0..1 | |
@Name | RoomDescription | The name of the room. | [string] | 1 |
RoomRates | RoomStay | A collection of Room Rates associated with a particular Room Stay. | 0..1 | |
RoomRate | RoomRates | A room rate. | 1..n | |
@RoomTypeCode | RoomRate | The ID of the room. | [integer] | 1 |
@NumberOfUnits | RoomRate | The number of rooms. | 1 |
1 |
@RatePlanCode | RoomRate | The ID of the rate. | [integer] | 1 |
Rates | RoomRate | Individual rate amount. | 1 | |
Rate | Rates | Rate amount information. | 1 | |
@EffectiveDate | Rate | Indicates the starting date. | [yyyy-MM-dd] | 1 |
Base | Rate | The base amount charged for the accommodation. | 0..1 | |
@AmountBeforeTax | Base | The total amount not including any associated tax. | [numeric] | 0..1 |
@AmountAfterTax | Base | The total amount including all associated taxes. | [numeric] | 1 |
@CurrencyCode | Base | EUR , GBP , USD , ... |
Refer to ISO 4217 | 0..1 |
@DecimalPlaces | Base | The ISO 4217 standard "minor unit" for the number of decimal places for a particular currency. | [integer] | 1 |
Total | RoomRate | The total of all rates for this room rate type. | 0..1 | |
@AmountBeforeTax | Total | The total amount not including any associated tax. | [numeric] | 0..1 |
@AmountAfterTax | Total | The total amount including all associated taxes. | [numeric] | 1 |
@CurrencyCode | Total | EUR , GBP , USD , ... |
Refer to ISO 4217 | 1 |
@DecimalPlaces | Total | The ISO 4217 standard "minor unit" for the number of decimal places for a particular currency. | [integer] | 0..1 |
GuestCounts | RoomStay | A collection of Guest Counts associated with Room Stay. | 0..1 | |
@IsPerRoom | GuestCounts | IsPerRoom means that the guests defined in the GuestCounts object apply to each room in the NumberOfRooms for the RoomStay. Value of false means that the guests defined in the GuestCounts object apply to all rooms combined in the NumberOfRooms for the RoomStay. |
true false |
1 |
GuestCount | GuestCounts | A recurring element that identifies the number of guests and ages of the guests. | 1..n | |
@AgeQualifyingCode | GuestCount | A code representing a business rule that determines the charges for a guest based upon age range. This attribute allows for an increase in rate by occupant class. | Refer to OpenTravel Code List Age Qualifying Code (AQC) | 1 |
@Count | GuestCount | The number of guests in one AgeQualifyingCode. | [integer] | 1 |
TimeSpan | RoomStay | The Time Span which covers the Room Stay. | 1 | |
@Start | TimeSpan | The starting value of the time span. | [yyyy-MM-dd] | 1 |
@End | TimeSpan | The ending value of the time span. | [yyyy-MM-dd] | 1 |
CancelPenalties | BookingRule | A collection of required payments that are part of the booking restriction. A collection of CancelPenalty. | 1 | |
@CancelPolicyIndicator | CancelPenalties | When true , indicates a cancel policy exists. When false , no cancel policy exists. Typically this indicator is used when details are not being sent. |
true false |
1 |
CancelPenalty | CancelPenalties | Defines the cancellation penalty of the hotel facility. The CancelPenalty class defines the cancellation policy of the hotel facility. | 1 | |
@NonRefundable | CancelPenalty | Indicates that any prepayment for the reservation is non-refundable, therefore a 100% penalty on the prepayment is applied, irrespective of deadline. | true false |
1 |
@PolicyCode | CancelPenalty | The ID of the cancellation policy. | Refer to Code List Policy Code | 1 |
Deadline | CancelPenalty | Cancellation deadline, absolute or relative. | 0..1 | |
@AbsoluteDeadline | Deadline | Defines the absolute deadline. Either this or the offset attributes may be used. | [HH:mm:ss] | 0..1 |
@OffsetDropTime | Deadline | An enumerated type indicating when the deadline drop time goes into effect. | BeforeArrival |
0..1 |
@OffsetTimeUnit | Deadline | The units of time that apply to the deadline. | Days Hours |
0..1 |
@OffsetUnitMultiplier | Deadline | The number of units of DeadlineTimeUnit. | [integer] | 0..1 |
PenaltyDescription | CancelPenalty | Text description of the Penalty in a given language. An indication of a new paragraph for a sub-section of a formatted text message. | 0..1 | |
Text | PenaltyDescription | Formatted text content. | [string] | 0..1 |
AmountPercent | CancelPenalty | Cancellation fee expressed as a fixed amount, or percentage of/or room nights. Defines the percentage basis for calculating the fee amount or the amount. | 0..1 | |
@ApplyAs | AmountPercent | Used to specify how the amount needs to be applied with respect to the stay. | FirstNightPayment |
0..1 |
@NmbrOfNights | AmountPercent | The number of nights of the hotel stay that are used to calculate the fee amount. | [integer] | 0..1 |
@Percent | AmountPercent | The percentage used to calculate the amount. | [double] | 0..1 |
@BasisType | AmountPercent | Provides the basis for how the amount of the guarantee is calculated. | FullStay Nights |
1 |
Total | RoomStay | The total amount charged for the Room Stay including additional occupant amounts and fees. | 1 | |
@AmountBeforeTax | Total | The total amount not including any associated tax. | [numeric] | 1 |
@AmountAfterTax | Total | The total amount including all associated taxes. | [numeric] | 1 |
@DecimalPlaces | Total | The ISO 4217 standard "minor unit" for the number of decimal places for a particular currency. | [string] | 0..1 |
ResGuestRPHs | RoomStay | A collection of unsigned integers serving as reference placeholders, and used as an index identifying which guests occupy this room | 1 | |
ResGuestRPH | ResGuestRPHs | This is a reference placeholder used as an index for a guest to be associated with this stay. | 1..n | |
@RPH | ResGuestRPH | Provides a unique reference to the guest. | [integer] | 1 |
ServiceRPHs | RoomStay | A collection of unsigned integers that reference the RPH (Reference Place holder) attribute in the Service object. The ServiceRPH attribute in the Service object is an indexing attribute that identifies the services attached to a specific guest or to the reservation. | 1 | |
ServiceRPH | ServiceRPHs | This is a reference placeholder used as an index for a service to be associated with this stay. | 1..n | |
@RPH | ServiceRPH | Provides a unique reference to the service. | [integer] | 1 |
Services | HotelReservation | Collection of services. 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. | 1 | |
Service | Services | A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges. | 0..n | |
@ServiceRPH | Service | A unique ID for a service that may be referenced elsewhere in the schema. | [integer] | 1 |
@ServiceInventoryCode | Service | The external code of the room the service applies to. | [integer] | 1 |
@ID | Service | A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. | [integer] | 1 |
Price | Service | The selling price of this Service. | 1 | |
@NumberOfUnits | Price | The number of services. | [integer] | 1 |
Base | Price | The base amount charged for the service per unit of time. | 1 | |
@AmountAfterTax | Price | The total amount including all associated taxes. | [numeric] | 1 |
@DecimalPlaces | Price | The ISO 4217 standard "minor unit" for the number of decimal places for a particular currency. | [integer] | 0..1 |
ServiceDetails | Service | 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. | 1 | |
GuestCounts | ServiceDetails | A collection of Guest Counts associated to the whole Reservation or a particular Room Stay or Service. A child Guest Count element is required for each distinct age group. A collection of GuestCount by age group. | 1 | |
GuestCount | GuestCounts | A recurring element that identifies the number of guests and ages of the guests. | 1 | |
@Count | GuestCount | The number of guests in one AgeQualifyingCode or Count. | [integer] | 1 |
TimeSpan | ServiceDetails | The Time Span which covers the Service. | 1 | |
@Start | TimeSpan | The starting value of the time span. | [yyyy-MM-dd] | 1 |
@End | TimeSpan | The ending value of the time span. | [yyyy-MM-dd] | 1 |
ServiceDescription | ServiceDetails | Description of the service. An indication of a new paragraph for a sub-section of a formatted text message. | 1 | |
Text | ServiceDescription | Formatted text content. | [CDATA string] | 1 |
TPA_Extensions | Service | A placeholder in the schema to allow for additional elements and attributes to be included per Trading Partner Agreement (TPA). Allows extensions to be added to the OpenTravel specification per trading partner agreement. | 1 | |
ServiceExtension | TPA_Extensions | An extension to the service. | 1 | |
@ServiceChargeType | ServiceExtension | The way the service is charged. | Refer to Code List Service Charge Type | 1 |
SelectedDates | ServiceExtension | A collection of dates on which the service is active. | 1 | |
Date | SelectedDates | A date on which the service is active. | 0..n | |
@Value | Date | The date. | [yyyy-MM-dd] | 1 |
ResGuests | HotelReservation | Collection of guests associated with the reservation. A collection of ResGuest objects, identifying the guests associated with this reservation. Which guests are in which room is determined by each RoomStays ResGuestRPHs collection. | 1 | |
ResGuest | ResGuests | The ResGuest object contains the information about a guest associated with a reservation.A collection of ResGuest objects, identifying the guests associated with this reservation. Which guests are in which room is determined by each RoomStays ResGuestRPHs collection. | 1 | |
@ResGuestRPH | ResGuest | This is a reference placeholder, used as an index for this guest in this reservation. In the ResGuest object it is used like all other RPH attributes to send the delta of a reservation. It is used by the RoomStay and Service objects to indicate which guests are associated with that room stay or service. | [integer] | 1 |
Profiles | ResGuest | A collection of Profile objects or Unique IDs of Profiles. | 1 | |
ProfileInfo | Profiles | A collection of Profiles or Unique IDs of Profiles. | 1 | |
Profile | ProfileInfo | Provides detailed information regarding either a company or a customer profile. Root element for profile content. | 1 | |
@ProfileType | Profile | Code to specify a profile such as Customer, Tour Operator, Corporation, etc. | Refer to OpenTravel Code List Profile Type (PRT).1 = Customer |
1 |
Customer | Profile | Detailed customer information for this profile. Contains basic data on the customer's identity, location, relationships, finances, memberships, etc. | 1 | |
@Gender | Customer | Identifies the gender. | Unknown Female Male |
1 |
PersonName | Customer | Detailed name information for the customer. This provides name information for a person. | 1 | |
GivenName | PersonName | Given name, first name or names. | [string] | 1 |
Surname | PersonName | Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name. | [string] | 1 |
UniqueID | ProfileInfo | A unique ID for a profile. This element repeats to accommodate multiple unique IDs for a single profile across multiple systems. An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). | 1 | |
@ID | UniqueID | A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. | [integer] | 1 |
@Type | UniqueID | A reference to the type of object defined by the UniqueID element. | Refer to OpenTravel Code List Unique ID Type (UIT).21 = Profile |
1 |
ResGlobalInfo | HotelReservation | ResGlobalInfo is a container for various information that affects the Reservation as a whole. These include global comments, counts, reservation IDs, loyalty programs, and payment methods. | 1 | |
TimeSpan | ResGlobalInfo | The Time Span which covers the Reservation, Room Stay or Service. | 1 | |
@Start | TimeSpan | The starting value of the time span. | [yyyy-MM-dd] | 1 |
@End | TimeSpan | The ending value of the time span. | [yyyy-MM-dd] | 1 |
Comments | ResGlobalInfo | A collection of Comment objects. Comments which apply to the whole Reservation or a particular Room Stay or Service. A collection of comments. | 1 | |
Comment | Comments | Comment details. | 0..n | |
Text | Comment | Formatted text content. | [string] | 1 |
Guarantee | ResGlobalInfo | The guarantee information associated to the Reservation or a particular Room Stay or Service. The guarantee information to hold a reservation | 0..1 | |
@GuaranteeType | Guarantee | An enumerated type defining the guarantee to be applied to this reservation. | CC/DC/Voucher |
1 |
GuaranteesAccepted | GuaranteeType | Guarantee Details. | 1 | |
GuaranteeAccepted | GuaranteesAccepted | Guarantee Detail. | 1 | |
@GuaranteeTypeCode | GuaranteeAccepted | Used to specify the method of guarantee. | Refer to OpenTravel Code List Payment Type (PMT).5 = Credit card |
1 |
PaymentCard | GuaranteeAccepted | Details of a debit or credit card. Specific payment card information. | 1 | |
@CardCode | PaymentCard | Issuer code. | [string] | 0..1 |
@ExpireDate | PaymentCard | Indicates the ending date. | [MMyy] | 0..1 |
CardHolderName | PaymentCard | Card holder name. | 0..1 | |
CardNumber | PaymentCard | Credit card number embossed on the card. Secure information that supports PCI tokens, data masking and other encryption methods. | 0..1 | |
PlainText | CardNumber | Non-secure (plain text) value. | [string] | 1 |
Total | ResGlobalInfo | The total amount charged for the accommodation including additional occupant amounts and fees. The total amount charged for the service including additional amounts and fees. | 1 | |
@AmountAfterTax | Total | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). | [numeric] | 1 |
@DecimalPlaces | Total | The ISO 4217 standard "minor unit" for the number of decimal places for a particular currency. | [integer] | 0..1 |
HotelReservationIDs | ResGlobalInfo | A Collection of HotelReservationID objects for a given reservation. The collection of all ReservationIDs can include Passenger Name Record (PNR), Guest Name Record (GNR) and Guest Folio numbers. Associated with each can be a Confirmation number which is usually given to the guest. | 1 | |
HotelReservationID | HotelReservationIDs | The HotelReservationID object contains various unique (ReservationID) and non unique (ConfirmationID, CancellationID) identifiers that the trading partners associate with a given reservation. | 0..n | |
@ResID_Type | HotelReservationID | Defines the type of Reservation ID (e.g. reservation number, cancellation number). | Refer to OpenTravel Code List Unique ID Type (UIT).5 = Travel agent14 = Reservation |
1 |
@ResID_Value | HotelReservationID | This is the actual value associated with ResID_Type as generated by the system that is the source of the ResID_Type. | [string] | 1 |
@ResID_Source | HotelReservationID | A unique identifier to indicate the source system which generated the ResID_Value. | [integer] | 0..1 |
@ResID_SourceContext | HotelReservationID | Additional information on Source. | [string] | 0..1 |
Profiles | ResGlobalInfo | A collection of Profile objects or Unique IDs of Profiles. | 1 | |
ProfileInfo | Profiles | A collection of Profiles or Unique IDs of Profiles. | 1 | |
Profile | ProfileInfo | Provides detailed information regarding either a company or a customer profile. Root element for profile content. | 1 | |
@ProfileType | Profile | Code to specify a profile such as Customer, Tour Operator, Corporation, etc. | Refer to OpenTravel Code List Profile Type (PRT).18 = Billing contact |
1 |
Customer | Profile | Detailed customer information for this profile. Contains basic data on the customer's identity, location, relationships, finances, memberships, etc. | 1 | |
@Gender | Customer | Identifies the gender. | Unknown Female Male |
1 |
PersonName | Customer | Detailed name information for the customer. This provides name information for a person. | 1 | |
GivenName | PersonName | Given name, first name or names. | [string] | 1 |
Surname | PersonName | Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name. | [string] | 1 |
Telephone | Customer | Information on a telephone number for the customer. | 0..1 | |
@PhoneNumber | Telephone | Telephone number assigned to a single location. | [string] | 1 |
Customer | Information on an email address for the customer. | [string] | 0..1 | |
Address | Customer | Detailed information on an address for the customer. | 0..1 | |
FormattedInd | Address | Specifies if the associated data is formatted or not. When true , then it is formatted; when false , then not formatted. |
true false |
1 |
AddressLine | Address | When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence. | [string] | 0..1 |
StreetNmbr | Address | May contain the street number and optionally the street name. | [string] | 0..1 |
CityName | Address | City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address). | [string] | 0..1 |
PostalCode | Address | Post Office Code number. | [string] | 0..1 |
CountryName | Address | The code of a country (e.g. NL ). |
Refer to ISO 3166-1 alpha-2 | 0..1 |
CompanyName | Address | Identifies a company. Identifies a company by name. | [string] | 0..1 |
@Department | CompanyName | The department name or ID with which the contact is associated. | [string] | 0..1 |
UniqueID | ProfileInfo | A unique ID for a profile. This element repeats to accommodate multiple unique IDs for a single profile across multiple systems. An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). | 1 | |
@ID | UniqueID | A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. | [integer] | 1 |
@Type | UniqueID | A reference to the type of object defined by the UniqueID element. | Refer to OpenTravel Code List Unique ID Type (UIT).21 = Customer |
1 |
TotalCommissions | ResGlobalInfo | The total commission for all rate segments in the reservation. Contains details pertaining to commissions. | 0..1 | |
CommissionPayableAmount | TotalCommissions | The amount of commission to be paid. | 1 | |
@Amount | CommissionPayableAmount | A monetary amount. | [numeric] | 1 |
@CurrencyCode | CommissionPayableAmount | EUR , GBP , USD , ... |
Refer to ISO 4217 | 0..1 |
@DecimalPlaces | CommissionPayableAmount | The ISO 4217 standard "minor unit" for the number of decimal places for a particular currency. | [integer] | 0..1 |
BasicPropertyInfo | ResGlobalInfo | Property information for the reservation. An abbreviated short summary of hotel descriptive information. | 1 | |
@HotelCode | BasicPropertyInfo | The ID of the hotel. | [integer] | 1 |
TPA_Extensions | HotelReservation | A placeholder in the schema to allow for additional elements and attributes to be included per Trading Partner Agreement (TPA). | 0..1 | |
PCIInformationUrl | TPA_Extension | This will display a URL to the SmartHOTEL vault for creditcard information. More information upon request. |
1 |