OTA_HotelResNotifRQ
The body of the message is to be an OTA_HotelResNotifRQ.
This message will be sent by the partner PMS application. The main payload of the OTA_HotelResNotifRQ message is a list of HotelReservation elements. The content may vary for different partner PMS applications depending on the application features and functionality supported by the respective partner PMS applications
In general, the following can be said about HotelReservations:
- A HotelReservation represents a single reservation made within the partner PMS application.
- A HotelReservation can have one or more RoomStays, one for each room type booked.
- A RoomStay represents a stay in one room type over a continuous timespan, non-continuous timespan stays (split stays) will result in multiple RoomStays.
- A HotelReservation can have zero, one or many ResGuests linked to either the RoomStay the guest stay in or the reservation.
OTA_HotelResNotifRQ Specification
| Element | Attribute | Number | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
OTA_HotelResNotifRQ | 1 | Root element of the message. | |||||||||
| @EchoToken | 1 | A reference for additional message identification, assigned by the requesting host system. | |||||||||
| @TimeStamp | 1 | ISO 8601 encoded timestamp indicating the creation date and time of the message. Format like yyyy-MM-dd'T'HH:mm:ssZZ i.e '2012-03-09T20:05:52+08:00' | |||||||||
| @Version | 1 | The OpenTravel message version indicated by a decimal value. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation | 1 | Contain the reservation details | |||||||||
| @ResStatus | 1 | Indicates the current status of the reservation. -Reserved | |||||||||
| @CreateDateTime | 1 | This is the date when the reservation was first made. Format like yyyy-MM-dd'T'HH:mm:ssZZ i.e '2012-03-09T20:05:52+08:00' | |||||||||
| @CreatorID | 0..1 | ID of creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation. | |||||||||
| @LastModifyDateTime | 0..1 | This indicates the last date and time when the reservation was last modified. Format like yyyy-MM-dd'T'HH:mm:ssZZ i.e '2012-03-09T20:05:52+08:00' | |||||||||
| @LastModifierID | 0..1 | Identifies the last software system or person to modify a record. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / POS | 1 | Point of Sale (POS) identifies the party or connection channel making the request. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / POS / Source | 1..10 | 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. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / POS / Source / RequestorID | 1 | This identifies the system which is sending the reservation. This element must appear in the first Source element. | |||||||||
| @ID | 1 | The ID used will be agreed by the trading partners and remain the same throughout the messages. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / POS / Source / BookingChannel | 0..2 | Name of the Booking Channel. Must be sent in a seperate 'Source' element to the 'RequestorID'. | |||||||||
| @Type | 1 | 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). | |||||||||
| @Primary | 0..1 | Indicates the primary booking source. Mandatory if there are multiple BookingChannel sources. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / POS / Source / BookingChannel / CompanyName | 1 | Identifies the company that is associated with the booking channel. | |||||||||
| @Code | 0..1 | Identifies a company by the company code. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / UniqueID | 1 | Used to provide PMS and/or CRS identifiers.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). | |||||||||
@ID | 1 | 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. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays | 1 | A collection of RoomStay objects. Room stays associated with this reservation. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay | 1..n | One instance of RoomStay per Room type booked. | |||||||||
| @MarketCode | 0..1 | The code that relates to the market being sold to (e.g., the corporate market, packages). | |||||||||
| @SourceOfBusiness | 0..1 | To specify where the business came from e.g. radio, newspaper ad, etc. | |||||||||
| @PromotionCode | 0..1 | Promotion code is the identifier used by the host to link directly with a specific named advertising campaign. By including the required code, the client is able to gain access to special offers which may have been created for a specifically targeted group via a CRM system or for a wider advertising campaign (TV, Press, Internet etc). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomTypes | 0..1 | A collection of Room Types associated with a particular Room Stay. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomTypes / RoomType | 0..1 | Provides details regarding rooms, usually guest rooms. Can be sent to give more information on the room type for this room stay. | |||||||||
| @RoomType | 0..1 | A code value that indicates the type of room for which this request is made, e.g.: double, king, etc. Values may use the Hotel Descriptive Content table or a codes specific to the property or hotel brand. | |||||||||
| @RoomTypeCode | 0..1 | Specific system room type code, ex: A1K, A1Q etc. | |||||||||
| @RoomCategory | 0..1 | Indicates the category of the room. Typical values would be Moderate, Standard, or Deluxe. Refer to OpenTravel Code List Segment Category Code (SEG). | |||||||||
| @RoomID | 0..1 | A string value representing the unique identification of a room if the request is looking for a specific room. | |||||||||
| @NonSmoking | 0..1 | Non-smoking indicator. | |||||||||
| @Configuration | 0..1 | Textual description of room configuration. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomTypes / RoomType / RoomDescription | 0..1 | Textual information regarding the room. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomTypes / RoomType / RoomDescription / Text | 0..n | A text description of the room | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomTypes / RoomType / AdditionalDetails | 0..1 | Container for additional information about this room. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomTypes / RoomType / AdditionalDetails / AdditionalDetail | 1..n | ||||||||||
| @Type | 0..1 | Used to define the type of information being sent (e.g., rate description, property description, room information). Refer to OpenTravel Code List Additional Detail Type (ADT). Some common usages are 43: Meal plan information | |||||||||
| @Code | 0..1 | Trading partner code associated to AdditionalDetailType. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomTypes / RoomType / AdditionalDetails / AdditionalDetail / DetailDescription | 0..1 | Textual description of AdditionalDetail information. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomTypes / RoomType / AdditionalDetails / AdditionalDetail / DetailDescription / Text | 0..n | A text description of AdditionalDetail | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RatePlans | 0..1 | A collection of Rate Plans associated with a particular Room Stay. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RatePlans / RatePlan | 1..n | Defines the details of the rate plan as used in the booking process. | |||||||||
| @RatePlanCode | 0..1 | Rate code, identifier for the rate plan. | |||||||||
| @EffectiveDate | 0..1 | The effective date of the RatePlan | |||||||||
| @ExpireDate | 0..1 | The expire date for a RatePlan, this should be considered an exclusive date, the date for which the current rate plan information is no longer valid. | |||||||||
| @RatePlanName | 0..1 | Provides the name of the rate plan or group. Typically used with RatePlanType to further describe the rate plan. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RatePlans / RatePlan / RatePlanDescription | 0..1 | Textual description of the RatePlan. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RatePlans / RatePlan / RatePlanDescription / Text | 0..n | A text description of the RatePlan. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RatePlans / RatePlan / RatePlanInclusions | Defines charges that are included in this rate plan. | ||||||||||
| @TaxInclusive | 0..1 | Indicates that service fees are included in the rate. | |||||||||
| @ServiceFeeInclusive | 0..1 | Indicates that tax is included in the rate. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RatePlans / RatePlan / RatePlanInclusions / RatePlanInclusionDescription | 0..1 | Textual description of what is included in the rate plan. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RatePlans / RatePlan / RatePlanInclusions / RatePlanInclusionDescription / Text | 0..n | A text description of the RatePlanInclusionDescription | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RatePlans / RatePlan / MealsIncluded | 0..n | ||||||||||
| @MealPlanIndicator | 0..1 | When true, a meal plan is included in this rate plan. When false, a meal plan is not included in this rate plan. | |||||||||
| @MealPlanCodes | 0..1 | Used to identify the types of meals included with a rate plan. Refer to OpenTravel Code List Meal Plan Type (MPT). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RatePlans / RatePlan / AdditionalDetails | 0..1 | Textual description of AdditionalDetail information. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RatePlans / RatePlan / AdditionalDetails / AdditionalDetail | 0..1 | A text description of AdditionalDetail | |||||||||
| @Type | 0..1 | Used to define the type of information being sent (e.g., rate description, property description, room information). Refer to OpenTravel Code List Additional Detail Type (ADT). | |||||||||
| @Code | 0..1 | Trading partner code associated to AdditionalDetailType. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RatePlans / RatePlan / AdditionalDetails / AdditionalDetail / DetailDescription | 0..1 | Textual description of AdditionalDetail information. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RatePlans / RatePlan / AdditionalDetails / AdditionalDetail / DetailDescription / Text | 0..n | A text description of AdditionalDetail | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates | 0..1 | A collection of Room Rates associated with a particular Room Stay. Each Room Rate combination can have multiple rates. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate | 1..n | ||||||||||
| @InvBlockCode | 0..1 | Code that identifies an inventory block. | |||||||||
| @NumberOfUnits | 0..1 | The number of rooms. | |||||||||
| @RoomID | 0..1 | A string value representing the unique identification of a room. | |||||||||
| @RoomTypeCode | 0..1 | Specfic system room type code, ex: A1K, A1Q etc. | |||||||||
| @RatePlanCode | 0..1 | A string value may be used to request a particular code or an ID if the guest qualifies for a specific rate, such as AARP, AAA, a corporate rate, etc., or to specify a negotiated code as a result of a negotiated rate. | |||||||||
| @RatePlanCategory | 0..1 | Hotel systems often group multiple rate plans into a single category. This refers to that category that is specific to the hotel CRS/ PMS and should not be confused with a GDS rate category. | |||||||||
| @EffectiveDate | 1 | Indicates the starting date. | |||||||||
| @ExpireDate | 1 | ExpireDate is the first day after the applicable period (e.g. when expire date is 2012-04-03 the last date of the period is 2012-04-02). Format yyyy-MM-dd. This date is exclusive. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / Rates | 0..1 | Container that will contain instances of Rates. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / Rates / Rate | 1..n | 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. | |||||||||
| @EffectiveDate | 0..1 | The Effective date attribute indicates the starting date of when a specific rate value is applied. This is needed when during the stay there are some rate changes and therefore one instance of when the Base element applies to part of the stay and another instance of when the Base element applies to another part of the stay. The effective date here refers to the Base that is passed in this instance of Rate element. | |||||||||
| @ExpireDate | 0..1 | The Expire date indicates the day when the specific value of the rate is changed to another value. | |||||||||
| @UnitMultiplier | 0..1 | UnitMultiplier is the number of RateTimeUnits that the rate amount is based upon (e.g., rate for one day in case of nightly rates). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / Rates / Rate / Base | 1 | The base amount charged for the accommodation or service per unit of time. Mandatory in both OpenTravel Alliance and HTNG if an instance of RoomRate is passed. | |||||||||
| @AmountBeforeTax | 0..1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). | |||||||||
| @AmountAfterTax | 0..1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). | |||||||||
| @CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / Rates / Rate / Base / Taxes | 0..1 | A collection of taxes. | |||||||||
| @CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |||||||||
| @Amount | 0..1 | A monetary amount of tax. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / Rates / Rate / Base / Taxes / Tax | 0..99 | An individual tax per 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. | |||||||||
| @Code | 0..1 | The type of tax being applied to the total. Refer to the OpenTravel Code List Fee Tax Type (FTT) | |||||||||
| @Amount | 0..1 | A monetary amount of tax. if zero, assume use of the Percent attribute (Amount or Percent must be a zero value). | |||||||||
| @CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |||||||||
| @Percent | 0..1 | Tax percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / Rates / Rate / Base / Taxes / Tax / TaxDescription | 0..5 | Text description of the taxes. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / Rates / Rate / Base / Taxes / Tax / TaxDescription / Text | 0..n | Textual description of the tax | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / Rates / Rate / Total | 1 | The Total amount charged for the accommodation or service per unit of time. Mandatory in both OpenTravel Alliance and HTNG if an instance of RoomRate is passed. | |||||||||
| @AmountBeforeTax | 0..1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). | |||||||||
| @AmountAfterTax | 0..1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). | |||||||||
| @CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / Rates / Rate / Total / Taxes | 0..1 | A collection of taxes. | |||||||||
| @CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |||||||||
| @Amount | 0..1 | A monetary amount of tax. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / Rates / Rate / Total / Taxes / Tax | 0..99 | An individual tax per 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. | |||||||||
| @Code | 0..1 | The type of tax being applied to the total. Refer to the OpenTravel Code List Fee Tax Type (FTT). | |||||||||
| @Amount | 0..1 | A monetary amount of tax. if zero, assume use of the Percent attribute (Amount or Percent must be a zero value). | |||||||||
| @CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |||||||||
| @Percent | 0..1 | Tax percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / Rates / Rate / Total / Taxes / Tax / TaxDescription | 0..5 | Text description of the taxes. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / Rates / Rate / Total / Taxes / Tax / TaxDescription / Text | 0..n | Textual description of the tax | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / ServiceRPHs | 0..1 | 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 this RoomRate. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / ServiceRPHs / ServiceRPH | 1..n | This is a reference placeholder used as an index for a service to be associated with this stay | |||||||||
| @RPH | 1 | Provides a unique reference to the service. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / GuestCounts | 0..1 | A collection of GuestCount by age group. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / GuestCounts / GuestCount | 1..99 | A recurring element that identifies the number of guests and ages of the guests. | |||||||||
| @AgeQualifyingCode | 0..1 | 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 OpenTravel Code List Age Qualifying Code (AQC). | |||||||||
| @Age | 0..1 | Defines the age of a guest. | |||||||||
| @Count | 0..1 | The number of guests in one AgeQualifyingCode or Count. | |||||||||
| @AgeBucket | 0..1 | Defines the age range category or bucket a guest can be booked into. This is typically used in conjunction with the age qualifying code to further define the applicable age range. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / TimeSpan | 1 | Contains the timespan which this RoomStay covers | |||||||||
| @Start | 1 | The ending value of the time span (Check in date) | |||||||||
| @End | 1 | The starting value of the time span (Check out date) | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Guarantee | 0..5 | The guarantee information to hold a reservation | |||||||||
| @GuaranteeCode | 0..1 | Guarantee Code | |||||||||
| @GuaranteeType | 0..1 | An enumerated type defining the guarantee to be applied to this reservation. Value: | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Guarantee / GuaranteesAccepted | 0..1 | The guarantee information associated to the Room Stay. A maximum of 5 occurrences are available for use depending on the context. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Guarantee / GuaranteesAccepted / GuaranteeAccepted | 1..n | Guarantee Detail. One of PaymentCard, Voucher, DirectBill elements must be included within GuranteeAccepted. | |||||||||
| @PaymentTransactionTypeCode | 0..1 | This is used to indicate either a charge, reserve (deposit) or refund.
| |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Guarantee / GuaranteesAccepted / GuaranteeAccepted / PaymentCard | 0..1 | Specific payment card information. Details of a debit or credit card. NOTE: PCI sensitive payment card information should not be included in the message. Please do not attempt to send any payment card data that there isn't a specific element or attribute for in the API. | |||||||||
| @CardCode | 0..1 | Issuer code. See OTA Payment Card Provider Codes | |||||||||
| @EffectiveDate | 0..1 | Indicates the starting date. | |||||||||
| @ExpireDate | 0..1 | Indicates the ending date. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Guarantee / GuaranteesAccepted / GuaranteeAccepted / PaymentCard / CardHolderName | 0..1 | Card holder name. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Guarantee / GuaranteesAccepted / GuaranteeAccepted / PaymentCard / CardNumber | 0..1 | Secure information that supports PCI tokens, data masking and other encryption methods. | |||||||||
| @Mask | Masked data. | ||||||||||
| @Token | Tokenized information. | ||||||||||
| @TokenProviderID | Provider ID. | ||||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Guarantee / GuaranteesAccepted / GuaranteeAccepted / Voucher | 0..1 | Details of a paper or electronic document indicating prepayment. | |||||||||
| @SeriesCode | 0..1 | Identification of a series of coupons or vouchers identified by serial number(s). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Guarantee / GuaranteesAccepted / GuaranteeAccepted / DirectBill | 0..1 | Details of a direct billing arrangement. | |||||||||
| @DirectBill_ID | 0..1 | Identifier for the organization to be billed directly for travel services. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Guarantee / GuaranteeDescription | 0..9 | Text description relating to the Guarantee. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Guarantee / GuaranteeDescription / Text | 0..n | Textual information relating to the Guarantee. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments | 0..1 | A collection of required payments. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment | 1..n | Used to define the deposit policy, guarantees policy, and/or accepted forms of payment. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment / AcceptedPayments | 0..1 | Collection of forms of payment accepted for payment.Used to define the types of payments accepted. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment / AcceptedPayments / AcceptedPayment | 0..1 | An acceptable form of payment. | |||||||||
| @PaymentTransactionTypeCode | 0..1 | This is used to indicate either a charge, reserve (deposit) or refund.
| |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment / AcceptedPayments / AcceptedPayment / PaymentCard | Specific payment card information. Details of a debit or credit card. NOTE: PCI sensitive payment card information should not be included in the message. Please do not attempt to send any payment card data that there isn't a specific element or attribute for in the API. | ||||||||||
| @CardCode | 0..1 | Issuer code. See OTA Payment Card Provider Codes | |||||||||
| @EffectiveDate | 0..1 | Indicates the starting date. | |||||||||
| @ExpireDate | 0..1 | Indicates the ending date. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment / AcceptedPayments / AcceptedPayment / PaymentCard / CardHolderName | 0..1 | Card holder name. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment / AcceptedPayments / AcceptedPayment / PaymentCard / CardNumber | 0..1 | Secure information that supports PCI tokens, data masking and other encryption methods. | |||||||||
| @Mask | Masked data. | ||||||||||
| @Token | Tokenized information. | ||||||||||
| @TokenProviderID | Provider ID. | ||||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment / AcceptedPayments / AcceptedPayment / Voucher | 0..1 | Details of a paper or electronic document indicating prepayment. | |||||||||
| @SeriesCode | 0..1 | Identification of a series of coupons or vouchers identified by serial number(s). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment / AcceptedPayments / AcceptedPayment / DirectBill | 0..1 | Details of a direct billing arrangement. | |||||||||
| DirectBill_ID | 0..1 | Identifier for the organization to be billed directly for travel services. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment / AmountPercent | 0.1 | Payment expressed as a fixed amount, or a percentage of/or room nights. If the the Total.amountAfterTax is provided, it will be a percentage of this value. If only the amountBeforeTax is provided it will be the percentage of this value. At least @Amount or @Percent will be populated. | |||||||||
| @Percent | 0..1 | The percentage used to calculate the amount. | |||||||||
| @CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |||||||||
| @Amount | 0..1 | A monetary amount taken for the deposit. | |||||||||
| @NmbrOfNights | 0..1 | The number of nights of the hotel stay that are used to calculate the fee amount. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment / AmountPercent / Taxes | 0..1 | A collection of taxes relating to the deposit. | |||||||||
| @CurrencyCode | 0..1 | ||||||||||
| @Amount | 0..1 | ||||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment / AmountPercent / Taxes / Tax | 0..99 | An individual tax. 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. | |||||||||
| @Code | 0..1 | Code identifying the fee (e.g.,agency fee, municipality fee). Refer to OpenTravel Code List Fee Tax Type (FTT). | |||||||||
| @Amount | 0..1 | A monetary amount of tax. | |||||||||
| @CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |||||||||
| @Percent | 0..1 | Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment / AmountPercent / Taxes / Tax / TaxDescription | 0..5 | Text description of the taxes. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment / AmountPercent / Taxes / Tax / TaxDescription / Text | 0..n | Textual description of the tax | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment / Deadline | 0..2 | Payment deadline, absolute or relative. | |||||||||
| @AbsoluteDeadline | 0..1 | Defines the absolute deadline. Either this or the offset attributes may be used. | |||||||||
| @OffsetTimeUnit | 0..1 | The units of time, e.g.: days, hours, etc., that apply to the deadline. | |||||||||
| @OffsetUnitMultiplier | 0..1 | The number of units of DeadlineTimeUnit. | |||||||||
| @OffsetDropTime | 0..1 | An enumerated type indicating when the deadline drop time goes into effect. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment / Description | 0..5 | Text description of the Payment in a given language. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment / Description / Text | 0..n | Textual information information relating to the payment. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment / Address | 0..1 | The address to which a deposit may be sent. | |||||||||
| @Type | 0..1 | Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment / Address / AddressLine | 0..5 | Address including any relevent street number. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment / Address / CityName | 0..1 | City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment / Address / PostalCode | 0..1 | ||||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment / Address / StateProv | 0..1 | State, province, or region name or code needed to identify location. | |||||||||
| @StateCode | 0..1 | The standard code or abbreviation for the state, province, or region. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / DepositPayments / GuaranteePayment / Address / CountryName | The name or code of a country (as used in an address). | ||||||||||
| @Code | 0..1 | ISO 3166 code for a country. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Discount | 0..1 | Discount percentage and/or Amount, code and textual reason for discount. | |||||||||
| @TaxInclusive | 0..1 | Is Discount tax inclusive. Boolean. | |||||||||
| @Percent | 0..1 | Percentage value of the discount. | |||||||||
| @DiscountCode | 0..1 | Specifies the type of discount (e.g., No condition, LOS, Deposit or Total amount spent). | |||||||||
| @AmountBeforeTax | 0.1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). | |||||||||
| @AmountAfterTax | 0..1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). | |||||||||
| @CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Discount / Taxes | 0..1 | A collection of taxes relating to Discount | |||||||||
| @CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |||||||||
| @Amount | 0..1 | A monetary amount of tax. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Discount / Taxes / Tax | 0..99 | 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. | |||||||||
| @Code | 0..1 | Code identifying the fee (e.g.,agency fee, municipality fee). Refer to OpenTravel Code List Fee Tax Type (FTT). | |||||||||
| @Amount | 0..1 | A monetary amount of tax. | |||||||||
| @CurrencyCode | 0.1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |||||||||
| @Percent | 0..1 | Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Discount / Taxes / Tax / TaxDescription | 0..5 | Text description of the taxes. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Discount / Taxes / Tax / TaxDescription / Text | 0..n | Textual description of the tax | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Discount / DiscountReason | 1 | Text description of Discount Reason. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Discount / DiscountReason / Text | 1 | Textual description of Discount Reason. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Total | 0..1 | The total amount charged for the service including additional amounts and fees. | |||||||||
| @AmountBeforeTax | 0..1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). | |||||||||
| @AmountAfterTax | 0..1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). | |||||||||
| @CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Total / Taxes | A collection of taxes relating to Discount | ||||||||||
| @CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |||||||||
| @Amount | 0..1 | A monetary amount of tax. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Total / Taxes / Tax | 0..99 | 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. | |||||||||
| @Code | 0..1 | Code identifying the fee (e.g.,agency fee, municipality fee). Refer to OpenTravel Code List Fee Tax Type (FTT). | |||||||||
| @Amount | 0..1 | A monetary amount of tax. | |||||||||
| @CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |||||||||
| @Percent | 0..1 | Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Total / Taxes / Tax / TaxDescription | 0..5 | Text description of the taxes. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Total / Taxes / Tax / TaxDescription / Text | 0..n | Textual description of Discount Reason. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / ResGuestRPHs | 0..1 | A collection of unsigned integers serving as reference placeholders, and used as an index identifying which guests occupy this roomA collection of unsigned integers serving as reference placeholders, and used as an index identifying which guests occupy this room | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / ResGuestRPH | 1..n | Used to link guests from the ResGuests list to the RoomStay | |||||||||
| @RPH | 1 | ||||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Memberships | 0..1 | A collection of Membership objects. Memberships provides a list of reward programs which may be credited with points accrued from the guest's activity. Which memberships are to be applied to which part is determined by each object's SelectedMembershipRPHs collection. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Memberships / Membership | 1..n | The SelectedMembership object identifies the frequent customer reward program and (optionally) indicates points awarded for stay activity. | |||||||||
| @ProgramCode | 0..1 | The code or name of the membership program ('Hertz', 'AAdvantage', etc.). | |||||||||
| @AccountID | 0..1 | The account identification number for this particular member in this particular program. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Comments | 0..1 | A collection of comments relating to the RoomStay. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Comments / Comment | 1..n | Comment details. | |||||||||
| @GuestViewable | 0..1 | When true, the comment may be shown to the consumer. When false, the comment may not be shown to the consumer. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Comments / Comment / Text | 1 | Comments. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / SpecialRequests | 0..1 | ||||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / SpecialRequests / SpecialRequest | 1..n | The SpecialRequests related to the RoomStay. | |||||||||
| @RequestCode | 0..1 | This identifies a special request for this reservation and is typically hotel-specific. | |||||||||
| @CodeContext | 0..1 | Identifies the source authority for the RequestCode. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / SpecialRequests / SpecialRequest / Text | 0..n | Textual information relating to the SpecialRequest. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / ServiceRPHs | 0..1 | ||||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / ServiceRPHs / ServiceRPH | 1..n | This is a reference placeholder used as an index for a service to be associated with this room. | |||||||||
| @RPH | 1 | ||||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / Services | 0..1 | 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. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / Services / Service | 1..n | A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges. | |||||||||
| @ServicePricingType | 0..1 | An enumerated type that defines how a service is priced. Values: Per stay, Per person, Per night, Per person per night, Per use. | |||||||||
| @ServiceCategoryCode | 0..1 | The representation of the specific service category for this specific service. | |||||||||
| @ServiceInventoryCode | 0..1 | The identifier code for the service as provided by the source booking channel or property management system. In the absence of a specific code being provided by the channel or property management system, the type of charge should be specified via one of the types outlined in the SMX For PMS API. | |||||||||
| @Inclusive | 0..1 | Whether the price for this service is included in the room rate. | |||||||||
| @Quantity | 0..1 | The number of units included in the charge. | |||||||||
| @ServiceRPH | 0..1 | This links a Service to a RoomStay or a RoomRate. The absence of a ServiceRPH indicates that this is a HotelReservation level charge | |||||||||
| @Type | 0..1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). | |||||||||
| @ID | 1 | 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. | |||||||||
| @ID_Context | 0..1 | Used to identify the source of the identifier (e.g., IATA, ABTA). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / Services / Service / Price | 0..99 | The selling price of this Service. Base charge and additional charges related to a room that includes such things as additional guest amounts, cancel fees, etc. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / Services / Service / Price / Total | 0..1 | The total amount charged for this rate including additional occupant amounts and fees.The total amount charged for the service including additional amounts and fees. | |||||||||
| @AmountBeforeTax | 0..1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). | |||||||||
| @AmountAfterTax | 0..1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). | |||||||||
| @CurrencyCode | 0..1 | The ISO currency code for the unit amount | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / Services / Service / Price / Total / Taxes | 0..1 | A collection of taxes. | |||||||||
| @CurrencyCode | 0..1 | The ISO currency code for the unit amount | |||||||||
| @Amount | 0..1 | A monetary amount. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / Services / Service / Price / Total / Taxes / Tax | 0..99 | An individual tax. 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. | |||||||||
| @Code | 0..1 | Code identifying the fee (e.g.,agency fee, municipality fee). Refer to OpenTravel Code List Fee Tax Type (FTT). | |||||||||
| @Amount | 0..1 | A monetary amount. | |||||||||
| @CurrencyCode | 0..1 | The ISO currency code for the unit amount | |||||||||
| @Percent | 0..1 | Fee percentage | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / Services / Service / Total / Taxes / Tax / TaxDescription | 0..5 | Text description of the taxes in a given language | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / Services / Service / Total / Taxes / Tax / TaxDescription / Text | 0..n | A text description of the tax | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / Services / Service / ServiceDetails | 0..1 | 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. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / Services / Service / ServiceDetails / GuestCounts | 0..1 | A collection of Guest Counts associated to the whole Reservation or a particular Room Stay or Service. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / Services / Service / ServiceDetails / GuestCounts / GuestCount | 0..99 | A recurring element that identifies the number of guests and ages of the guests. | |||||||||
| @AgeQualifyingCode | 0..1 | 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 OpenTravel Code List Age Qualifying Code (AQC). | |||||||||
| @Age | 0..1 | Defines the age of a guest. | |||||||||
| @Count | 0..1 | The number of guests in one AgeQualifyingCode or Count. | |||||||||
| @AgeBucket | 0..1 | Defines the age range category or bucket a guest can be booked into. This is typically used in conjunction with the age qualifying code to further define the applicable age range. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / Services / Service / ServiceDetails / GuestCounts / TimeSpan | 0..1 | The Time Span which covers the Service. | |||||||||
| @Start | 0..1 | The starting value of the time span. | |||||||||
| @End | 0..1 | The ending value of the time span. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / Services / Service / ServiceDetails / GuestCounts / Comments | 0..1 | A collection of Comment objects. Comments which apply to the Service. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / Services / Service / ServiceDetails / Comments / Comment | 0..n | Comment details. | |||||||||
| @GuestViewable | 0..1 | When true, the comment may be shown to the consumer. When false, the comment may not be shown to the consumer. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / Services / Service / ServiceDetails / Comments / Comment / Text | 0..n | Service detail comments | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / Services / Service / ServiceDetails / ServiceDescription | 0..1 | Description of the service | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / Services / Service / ServiceDetails / ServiceDescription / Text | 0..n | A text description of the service | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / Services / ServiceCategory | 0..n | Hotel systems often group multiple services into a single category. This refers to that category that is specific to the hotel CRS/PMS. | |||||||||
| @ServiceCategoryCode | 1 | The representation of the specific service category for the service being reserved. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / BillingInstructionsCode | 0..n | Billing codes that apply to a set of instructions for a set of transactions that are routed to a designated folio. | |||||||||
| @BillingCode | 1 | The individual billing code that applies to a set of instructions that are routed to a designated folio. | |||||||||
| @AccountNumber | 0..1 | Identifies the account number where the charges will be routed. | |||||||||
| @Start | 0..1 | The starting value of the time span. | |||||||||
| @End | 0..1 | The ending value of the time span. | |||||||||
| @AuthorizationCode | 0..1 | The authorization code associated with the billing code. | |||||||||
| @Description | 0..1 | A short description of the billing code or instructions. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / BillingInstructionsCode / ResGuestRPH | 0..1 | A reference to a guest ID object that may be defined in ResGuests/ResGuest | |||||||||
| @RPH | 0..1 | A unique reference to the guest ID. | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests | 0..1 | Collection of guests associated with the reservation. Which guests are in which room is determined by each RoomStay's ResGuestRPHs collection. | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest | 1..n | 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. | |||||||||
| @ResGuestRPH | 0..1 | 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. | |||||||||
| @AgeQualifyingCode | 0..1 | 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). Refer to OpenTravel Code List Age Qualifying Code (AQC). | |||||||||
| @ArrivalTime | 0..1 | Timestamp which represents the date and time of the guest's arrival at the hotel. Format like HH:mm:ss. | |||||||||
| @PrimaryIndicator | 0..1 | When true, indicates this is the primary guest. Only one ResGuest can be the primary guest. | |||||||||
| @Age | 0..1 | The age of the guest. | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles | 0..1 | A collection of Profiles or Unique IDs of Profiles. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo | 1..n | ||||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / UniqueID | 0..9 | A unique ID for a profile. This element can repeat to accommodate multiple unique IDs for a single profile across multiple systems. | |||||||||
| @ID | 1 | 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. | |||||||||
| @Type | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). | |||||||||
| @ID_Context | 0..1 | Used to identify the source of the identifier. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile | 1 | Provides detailed information regarding either a company or a customer profile. | |||||||||
| @ShareAllOptOutInd | 0..1 | When 'true', a customer has explicitly opted out of marketing communication. This is used in combination with the ShareAllMarketInd and only one of these attributes should have a value of 'true'. | |||||||||
| @ShareAllMarketInd | 0..1 | Permission for sharing all data in profile for marketing purposes. A 'true' value indicates that the customer has chosen to opt-in to marketing communication. This is used in combination with the ShareAllOptOutInd and only one of these attributes should have a value of 'true'. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer | 0..1 | Detailed customer information for this profile. | |||||||||
| @VIP_Indicator | 0..1 | If true, indicates a very important person. | |||||||||
| @CustomerValue | 0..1 | The supplier's ranking of the customer (e.g., VIP, numerical ranking). | |||||||||
| @BirthDate | 0..1 | The customer’s birthday information. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / PersonName | 0..1 | Detailed name information for the customer. | |||||||||
| @Language | 0..1 | The language code for which the name data is represented. | |||||||||
| @NameType | 0..1 | Former, Nickname, Alternate, etc. Please refer to OpenTravel Code List Name Type (NAM). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / PersonName / NamePrefix | 0..3 | Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / PersonName / GivenName | 0..5 | Given name, first name or names. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / PersonName / MiddleName | 0..3 | The middle name of the person name. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / PersonName / Surname | 1 | Family or last name. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / PersonName / NameSuffix | 0..3 | Name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.) | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / PersonName / NameTitle | 0..5 | Degree or honours (e.g., Ph.D., M.D.) | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / Telephone | 0..5 | Information on a telephone number for the customer. | |||||||||
| @PhoneLocationType | 0..1 | Describes the location of the phone, such as Home, Office, Property Reservation Office, etc. Refer to OpenTravel Code List Phone Location Type (PLT). | |||||||||
| @PhoneTechType | 0..1 | Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT). | |||||||||
| @PhoneNumber | 1 | Telephone number assigned to a single location. | |||||||||
| @CountryAccessCode | 0..1 | Code assigned by telecommunications authorities for international country access identifier. | |||||||||
| @AreaCityCode | 0..1 | Code assigned for telephones in a specific region, city, or area. | |||||||||
| @FormattedInd | 0..1 | Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted. | |||||||||
| @DefaultInd | 0..1 | When true, indicates a default value should be used. | |||||||||
| @Remark | 0..1 | A remark associated with the telephone number. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / Email | 0..5 | Information on an email address for the customer. | |||||||||
| @EmailType | 0..1 | Defines the purpose of the e-mail address (e.g. personal, business, listserve). Refer to OpenTravel Code List Email Address Type (EAT). | |||||||||
| @DefaultInd | 0..1 | When true, indicates a default value should be used. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / Address | 0..5 | Detailed information on an address for the customer. | |||||||||
| @Type | 0..1 | Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / Address / AddressLine | 0..5 | These lines will contain free form address details. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / Address / CityName | 0..1 | City (e.g., Dublin), town, or postal station. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / Address / StateProv | 0..1 | State, province, or region name. | |||||||||
| @StateCode | 0..1 | The standard code or abbreviation for the state, province, or region. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / Address / PostalCode | 0..1 | Post Office Code number. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / Address / CompanyName | 0..1 | Identifies a company. | |||||||||
| @Code | 0..1 | Identifies a company by the company code. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / Address / CountryName | 0..1 | Country name (e.g., Ireland). | |||||||||
| @Code | 0..1 | ISO 3166 code for a country. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / Address / AddresseeName | 0..1 | Name of the person to whom this address relates. | |||||||||
| @Language | 0..1 | The language code for which the name data is represented. | |||||||||
| @NameType | 0..1 | Former, Nickname, Alternate, etc. Please refer to OpenTravel Code List Name Type (NAM). | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / Address / AddresseeName / NamePrefix | 0..3 | Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / Address / AddresseeName / GivenName | 0..5 | Given name, first name or names. | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / Address / AddresseeName / MiddleName | 0..3 | The middle name of the person name. | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / Address / AddresseeName / Surname | 1 | Family or last name. | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / Address / AddresseeName / NameSuffix | 0..3 | Name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.) | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / Address / AddresseeName / NameTitle | 0..5 | Degree or honours (e.g., Ph.D., M.D.) | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / RelatedTraveler | 0..n | Identifies a traveler associated with the customer. | |||||||||
| @Relation | 0..1 | Indicates the type of relationship with the person in the profile, such as Spouse, Child, Family, Business Associate, Interest Group, Medical, Security, Other, etc. | |||||||||
| @BirthDate | 0..1 | The related traveler’s birthday information. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / RelatedTraveler / UniqueID | 0..1 | ||||||||||
| @ID | 1 | 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. | |||||||||
| @Type | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). | |||||||||
| @ID_Context | 0..1 | Used to identify the source of the identifier. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / RelatedTraveler / PersonName | 0..1 | ||||||||||
| @Language | 0..1 | The language code for which the name data is represented. | |||||||||
| @NameType | 0..1 | Former, Nickname, Alternate, etc. Please refer to OpenTravel Code List Name Type (NAM). | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / RelatedTraveler / PersonName / NamePrefix | 0..3 | Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / RelatedTraveler / PersonName / GivenName | 0..5 | Given name, first name or names. | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / RelatedTraveler / PersonName / MiddleName | 0..3 | The middle name of the person name. | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / RelatedTraveler / PersonName / Surname | 1 | Family or last name. | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / RelatedTraveler / PersonName / NameSuffix | 0..3 | Name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.) | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / RelatedTraveler / PersonName / NameTitle | 0..5 | Degree or honours (e.g., Ph.D., M.D.) | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / CustLoyalty | 0..25 | Loyalty program information for the customer. | |||||||||
| @ProgramID | 0..1 | The ProgramID attribute can be used to indicate the program that is being passed. For instance, we could use it to pass: Frequent Guest, Frequent Traveller and Company ID. | |||||||||
| @MembershipID | 0..1 | The membershipID attribute will indicate the actual number. | |||||||||
| @LoyalLevel | 0..1 | Indicates special privileges in program assigned to individual. | |||||||||
| @LoyalLevelCode | 0..1 | Provides a numeric code assigned to a particular loyalty level. | |||||||||
| @EffectiveDate | 0..1 | Indicates the starting date of the program. | |||||||||
| @ExpireDate | 0..1 | Indicates the expiration date of the program. | |||||||||
| @SignupDate | 0..1 | Indicates the customer’s sign-up date. | |||||||||
| @Remark | 0..1 | A remark associated with the customer's loyalty program. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo | 0..1 | Detailed information about a company. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / CompanyName | 0..1 | Identifies a company by name. | |||||||||
| @Code | 0..1 | Identifies a company by the company code. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / AddressInfo | 0..5 | ||||||||||
| @Type | 0..1 | Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / AddressInfo / AddressLine | 0..5 | These lines will contain free form address details. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / AddressInfo / CityName | 0..1 | City (e.g., Dublin), town, or postal station. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / AddressInfo / StateProv | 0..1 | State, province, or region name. | |||||||||
| @StateCode | 0..1 | The standard code or abbreviation for the state, province, or region. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / AddressInfo / PostalCode | 0..1 | Post Office Code number. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / AddressInfo / CountryName | 0..1 | Country name (e.g., Ireland). | |||||||||
| @Code | 0..1 | ISO 3166 code for a country. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / TelephoneInfo | 0..n | Information on a telephone number for the company. | |||||||||
| @PhoneLocationType | 0..1 | Describes the location of the phone, such as Home, Office, Property Reservation Office, etc. Refer to OpenTravel Code List Phone Location Type (PLT). | |||||||||
| @PhoneTechType | 0..1 | Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT). | |||||||||
| @PhoneNumber | 1 | Telephone number assigned to a single location. | |||||||||
| @CountryAccessCode | 0..1 | Code assigned by telecommunications authorities for international country access identifier. | |||||||||
| @AreaCityCode | 0..1 | Code assigned for telephones in a specific region, city, or area. | |||||||||
| @FormattedInd | 0..1 | Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted. | |||||||||
| @DefaultInd | 0..1 | When true, indicates a default value should be used. | |||||||||
| @Remark | 0..1 | A remark associated with the telephone number. | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / Email | 0..5 | Information on an email address for the company. | |||||||||
| @EmailType | 0..1 | Defines the purpose of the e-mail address (e.g. personal, business, listserve). Refer to OpenTravel Code List Email Address Type (EAT). | |||||||||
| @DefaultInd | 0..1 | When true, indicates a default value should be used. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson | 0..n | Information on a contact person for the company. Name of an individual and appropriate contact information. May be contact information for the customer or someone affiliated with the customer. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / PersonName | 0..1 | ||||||||||
| @Language | 0..1 | The language code for which the name data is represented. | |||||||||
| @NameType | 0..1 | Former, Nickname, Alternate, etc. Please refer to OpenTravel Code List Name Type (NAM). | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / PersonName / NamePrefix | 0..3 | Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / PersonName / GivenName | 0..5 | Given name, first name or names. | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / PersonName / MiddleName | 0..3 | The middle name of the person name. | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / PersonName / Surname | 1 | Family or last name. | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / PersonName / NameSuffix | 0..3 | Name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.) | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / PersonName / NameTitle | 0..5 | Degree or honours (e.g., Ph.D., M.D.) | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / Telephone | 0..5 | Information on a telephone number for the customer. | |||||||||
| @PhoneLocationType | 0..1 | Describes the location of the phone, such as Home, Office, Property Reservation Office, etc. Refer to OpenTravel Code List Phone Location Type (PLT). | |||||||||
| @PhoneTechType | 0..1 | Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT). | |||||||||
| @PhoneNumber | 1 | Telephone number assigned to a single location. | |||||||||
| @CountryAccessCode | 0..1 | Code assigned by telecommunications authorities for international country access identifier. | |||||||||
| @AreaCityCode | 0..1 | Code assigned for telephones in a specific region, city, or area. | |||||||||
| @FormattedInd | 0..1 | Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted. | |||||||||
| @DefaultInd | 0..1 | When true, indicates a default value should be used. | |||||||||
| @Remark | 0..1 | A remark associated with the telephone number. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / Address | 0..5 | Detailed information on an address for the contact person for the company. | |||||||||
| @Type | 0..1 | Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT). | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / Address / AddressLine | 0..5 | These lines will contain free form address details. | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / Address / CityName | 0..1 | City (e.g., Dublin), town, or postal station. | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / Address / StateProv | 0..1 | State, province, or region name. | |||||||||
| @StateCode | 0..1 | The standard code or abbreviation for the state, province, or region. | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / Address / PostalCode | 0..1 | Post Office Code number. | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / Address / CountryName | 0..1 | Country name (e.g., Ireland). | |||||||||
| @Code | 0..1 | ISO 3166 code for a country. | |||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / Address / CountryName / Email | 0..5 | Information on an email address for the contact person for the company. | |||||||||
| @EmailType | 0..1 | Defines the purpose of the e-mail address (e.g. personal, business, listserve). Refer to OpenTravel Code List Email Address Type (EAT). | |||||||||
| @DefaultInd | 0..1 | When true, indicates a default value should be used. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / SpecialRequests | 0..1 | ||||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / SpecialRequests / SpecialRequest | 1..n | The SpecialRequest object indicates special requests for a particular guest, service or reservation. | |||||||||
| @RequestCode | 0..1 | This identifies a special request for this reservation and is typically hotel-specific. | |||||||||
| @CodeContext | 0..1 | Identifies the source authority for the RequestCode. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / SpecialRequests / SpecialRequest / Text | 0..1 | Provides more information about the request code or provides description for requests that are yet uncoded. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations/ HotelReservation / ResGuests / ResGuest / Comments / Comment | 1 | Comment details. | |||||||||
| @Name | 0..1 | Allows types of Comments to be differentiated. | |||||||||
| @GuestViewable | 1 | This indicates that the comment can actually be seen by the guest and is necessary when two different types of comments are passed: one which is guest viewable and one that isn’t. The Attribute is of Boolean nature. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations/ HotelReservation / ResGuests / ResGuest / Comments / Comment / Text | 1 | Comments. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations/ HotelReservation / ResGuests / ResGuest / ServiceRPHs | 0..1 | ||||||||||
| OTA_HotelResNotifRQ / HotelReservations/ HotelReservation / ResGuests / ResGuest / ServiceRPHs / ServiceRPH | 1..n | This is a reference placeholder used as an index for a service to be associated with this guest. | |||||||||
| @RPH | 1 | ||||||||||
| OTA_HotelResNotifRQ / HotelReservations/ HotelReservation / ResGuests / ResGuest / ArrivalTransport | 0..1 | Contains information about the arrival transportation for a guest | |||||||||
| OTA_HotelResNotifRQ / HotelReservations/ HotelReservation / ResGuests / ResGuest / ArrivalTransport / TransportInfo | 1..n | Indicates transportation information for a guest. | |||||||||
| @Type | 0..1 | Method of conveyance of this guest. Values: Air, Rail, Bus, Boat, Private Auto, Other. | |||||||||
| @ID | 0..1 | Identifier of this transportation method (e.g., flight number). | |||||||||
| @Time | 0..1 | Time of transportation. Local time of the location indicated by the LocationCode. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations/ HotelReservation / ResGuests / ResGuest / DepartureTransport | 0..1 | Contains information about the departure transportation for a guest | |||||||||
| OTA_HotelResNotifRQ / HotelReservations/ HotelReservation / ResGuests / ResGuest / DepartureTransport / TransportInfo | 1..n | Indicates transportation information for a guest. | |||||||||
| @Type | 0..1 | Method of conveyance of this guest. Values: Air, Rail, Bus, Boat, Private Auto, Other. | |||||||||
| @ID | 0..1 | Identifier of this transportation method (e.g., flight number). | |||||||||
| @Time | 0..1 | Time of transportation. Local time of the location indicated by the LocationCode. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo | 1 | A container for various information that affects the Reservation as a whole. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / GuestCounts | 0..1 | ||||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / GuestCounts / GuestCount | 1..99 | A recurring element that identifies the number of guests and ages of the guests. | |||||||||
| @AgeQualifyingCode | 0..1 | 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 OpenTravel Code List Age Qualifying Code (AQC). | |||||||||
| @Age | 0..1 | Defines the age of a guest. | |||||||||
| @Count | 0..1 | The number of guests in one AgeQualifyingCode or Count. | |||||||||
| @AgeBucket | 0..1 | Defines the age range category or bucket a guest can be booked into. This is typically used in conjunction with the age qualifying code to further define the applicable age range. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / TimeSpan | 1 | The Time Span which covers the Reservation | |||||||||
| @Start | 1 | The ending value of the time span (Check in date) | |||||||||
| @End | 1 | The starting value of the time span (Check out date) | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Memberships | 0..1 | A collection of Membership objects. Memberships provides a list of reward progream which may be credited with points accrued from the guest's activity. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Memberships / Membership | 0..n | The Membership object identifes the frequent customer reward program. | |||||||||
| @ProgramCode | 0..1 | The code or name of the membership program ('Hertz', 'AAdvantage', etc.). | |||||||||
| @AccountID | 0..1 | The account identification number for this particular member in this particular program. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Comments | 0..1 | A collection of Comment objects. Comments which apply to the Service. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Comments / Comment | 0..n | Comment details. | |||||||||
| @GuestViewable | 0..1 | When true, the comment may be shown to the consumer. When false, the comment may not be shown to the consumer. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Comments / Comment / Text | 0..n | Reservation comments | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / SpecialRequests | 0..1 | ||||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / SpecialRequests / SpecialRequest | 1..n | The SpecialRequest object indicates special requests for a particular guest, service or reservation. | |||||||||
| @RequestCode | 0..1 | This identifies a special request for this reservation and is typically hotel-specific. | |||||||||
| @CodeContext | 0..1 | Identifies the source authority for the RequestCode. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / SpecialRequests / SpecialRequest / Text | 0..n | Provides more information about the request code or provides description for requests that are yet uncoded. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Guarantee | 0..5 | The guarantee information to hold a reservation | |||||||||
| @GuaranteeCode | 0..1 | Guarantee Code | |||||||||
| @GuaranteeType | 0..1 | An enumerated type defining the guarantee to be applied to this reservation. Value: | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Guarantee / GuaranteesAccepted | 0..1 | The guarantee information associated to the reservation. A maximum of 5 occurances are available for use depending on the context. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Guarantee / GuaranteesAccepted / GuaranteeAccepted | 1..n | Guarantee Detail. | |||||||||
| @PaymentTransactionTypeCode | 0..1 | This is used to indicate either a charge, reserve (deposit) or refund.
| |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Guarantee / GuaranteesAccepted / GuaranteeAccepted / PaymentCard | 0..1 | Specific payment card information. Details of a debit or credit card. NOTE: PCI sensitive information is out of scope in Payment card. Please do not attempt to parse any 'out of scope' elements / data. | |||||||||
| @CardCode | 0..1 | Issuer code. See OTA Payment Card Provider Codes | |||||||||
| @EffectiveDate | 0..1 | Indicates the starting date. | |||||||||
| @ExpireDate | 0..1 | Indicates the ending date. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Guarantee / GuaranteesAccepted / GuaranteeAccepted / PaymentCard / CardHolderName | |||||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Guarantee / GuaranteesAccepted / GuaranteeAccepted / PaymentCard / CardNumber | 0..1 | Secure information that supports PCI tokens, data masking and other encryption methods. | |||||||||
| @Mask | Masked data. | ||||||||||
| @Token | Tokenized information. | ||||||||||
| @TokenProviderID | Provider ID. | ||||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Guarantee / GuaranteesAccepted / GuaranteeAccepted /Voucher | 0..1 | Details of a paper or electronic document indicating prepayment. | |||||||||
| @SeriesCode | 0..1 | Identification of a series of coupons or vouchers identified by serial number(s). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Guarantee / GuaranteesAccepted / GuaranteeAccepted / DirectBill | 0..1 | Details of a direct billing arrangement. | |||||||||
| @DirectBill_ID | 0..1 | Identifier for the organization to be billed directly for travel services. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / DepositPayments / GuaranteePayment | 1..n | Used to define the deposit policy, guarantees policy, and/or accepted forms of payment. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / DepositPayments / GuaranteePayment / AcceptedPayments | 0..1 | Collection of forms of payment accepted for payment.Used to define the types of payments accepted. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / DepositPayments / GuaranteePayment / AcceptedPayments / AcceptedPayment | 0..1 | An acceptable form of payment. | |||||||||
| @PaymentTransactionTypeCode | 0..1 | This is used to indicate either a charge, reserve (deposit) or refund.
| |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / DepositPayments / GuaranteePayment / AcceptedPayments / AcceptedPayment / PaymentCard | Specific payment card information. Details of a debit or credit card.
| ||||||||||
| @CardCode | 0..1 | Issuer code. See OTA Payment Card Provider Codes | |||||||||
| @EffectiveDate | 0..1 | Indicates the starting date. | |||||||||
| @ExpireDate | 0..1 | Indicates the ending date. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / DepositPayments / GuaranteePayment / AcceptedPayments / AcceptedPayment / PaymentCard / CardHolderName | 0..1 | Card holder name. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / DepositPayments / GuaranteePayment / AcceptedPayments / AcceptedPayment / PaymentCard / CardNumber | 0..1 | Secure information that supports PCI tokens, data masking and other encryption methods. | |||||||||
| @Mask | 0..1 | Masked data. | |||||||||
| @Token | 0..1 | Tokenized information. | |||||||||
| @TokenProviderID | 0..1 | Provider ID. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / DepositPayments / GuaranteePayment / AcceptedPayments / AcceptedPayment / Voucher | 0..1 | Details of a paper or electronic document indicating prepayment. | |||||||||
| @SeriesCode | 0..1 | Identification of a series of coupons or vouchers identified by serial number(s). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / DepositPayments / GuaranteePayment / AcceptedPayments / AcceptedPayment / DirectBill | 0..1 | Details of a direct billing arrangement. | |||||||||
| @DirectBill_ID | 0..1 | Identifier for the organization to be billed directly for travel services. | |||||||||
| @Amount | 0..1 | A monetary amount taken for the deposit. | |||||||||
| @NmbrOfNights | 0..1 | The number of nights of the hotel stay that are used to calculate the fee amount. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / DepositPayments / GuaranteePayment / AmountPercent | 0.1 | Payment expressed as a fixed amount, or a percentage of/or room nights. If the the Total.amountAfterTax is provided, it will be a percentage of this value. If only the amountBeforeTax is provided it will be the percentage of this value. At least @Amount or @Percent will be populated. | |||||||||
| @Percent | 0..1 | The percentage used to calculate the amount. | |||||||||
| @CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |||||||||
| @Amount | 0..1 | A monetary amount taken for the deposit. | |||||||||
| @NmbrOfNights | 0..1 | The number of nights of the hotel stay that are used to calculate the fee amount. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / DepositPayments / GuaranteePayment / AmountPercent / Taxes | 0..1 | A collection of taxes relating to the deposit. | |||||||||
| @CurrencyCode | 0..1 | ||||||||||
| @Amount | 0..1 | ||||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / DepositPayments / GuaranteePayment / AmountPercent / Taxes / Tax | 0..99 | An individual tax. 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. | |||||||||
| @Code | 0..1 | Code identifying the fee (e.g.,agency fee, municipality fee). Refer to OpenTravel Code List Fee Tax Type (FTT). | |||||||||
| @Amount | 0..1 | A monetary amount of tax. | |||||||||
| @CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |||||||||
| @Percent | 0..1 | Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / DepositPayments / GuaranteePayment / Deadline | 0..2 | Payment deadline, absolute or relative. | |||||||||
| @AbsoluteDeadline | 0..1 | Defines the absolute deadline. Either this or the offset attributes may be used. | |||||||||
| @OffsetTimeUnit | 0..1 | The units of time, e.g.: days, hours, etc., that apply to the deadline. | |||||||||
| @OffsetUnitMultiplier | 0..1 | The number of units of DeadlineTimeUnit. | |||||||||
| @OffsetDropTime | 0..1 | An enumerated type indicating when the deadline drop time goes into effect. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / DepositPayments / GuaranteePayment / Description | 0..5 | Text description of the Payment in a given language. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / DepositPayments / GuaranteePayment / Description / Text | 0..n | Textual information information relating to the payment. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / DepositPayments / GuaranteePayment / Address | 0..1 | The address to which a deposit may be sent. | |||||||||
| @Type | 0..1 | Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / DepositPayments / GuaranteePayment / Address / AddressLine | 0..5 | Address including any relevent street number. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / DepositPayments / GuaranteePayment / Address / CityName | 0..1 | City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / DepositPayments / GuaranteePayment / Address / PostalCode | 0..1 | ||||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / DepositPayments / GuaranteePayment / Address / StateProv | 0..1 | State, province, or region name or code needed to identify location. | |||||||||
| @StateCode | 0..1 | The standard code or abbreviation for the state, province, or region. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / DepositPayments / GuaranteePayment / Address / CountryName | The name or code of a country (as used in an address). | ||||||||||
| @Code | 0..1 | ISO 3166 code for a country. | |||||||||
| @Type | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). | |||||||||
| @ID_Context | 0..1 | Used to identify the source of the identifier. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Total | 1 | ||||||||||
| @AmountBeforeTax | 0..1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). | |||||||||
| @AmountAfterTax | 0..1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). | |||||||||
| @CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / HotelReservationIDs | 0..1 | A Collection of HotelReservationID objects for a given reservation. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / HotelReservationIDs / HotelReservationID | 0..n | The HotelReservationID object contains various unique (ReservationID) and non unique (ConfirmationID, CancellationID) identifiers that the trading partners associate with a given reservation. | |||||||||
| @ResID_Type | 1 | Defines the type of Reservation ID (e.g. reservation number, cancellation number). Refer to OpenTravel Code List Unique ID Type (UIT). | |||||||||
| @ResID_Value | 1 | This is the actual value associated with ResID_Type | |||||||||
| @ResID_Source | 0..1 | A unique identifier to indicate the source system which generated the ResID_Value. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles | 0..1 | ||||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo | 1..n | ||||||||||
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / UniqueID | 0..9 | A unique ID for a profile. This element can repeat to accommodate multiple unique IDs for a single profile across multiple systems. | |||||||||
| @ID | 1 | 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. | |||||||||
| @Type | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). | |||||||||
| @ID_Context | 0..1 | Used to identify the source of the identifier. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile | 1 | Provides detailed information regarding either a company or a customer profile. | |||||||||
| @ProfileType | 1 | Code to specify a profile such as Customer, Corporation, etc. Refer to OpenTravel Code List Profile Type (PRT). | |||||||||
| @ShareAllOptOutInd | 0..1 | When 'true', a customer has explicitly opted out of marketing communication. This is used in combination with the ShareAllMarketInd and only one of these attributes should have a value of 'true'. | |||||||||
| @ShareAllMarketInd | 0..1 | Permission for sharing all data in profile for marketing purposes. A 'true' value indicates that the customer has chosen to opt-in to marketing communication. This is used in combination with the ShareAllOptOutInd and only one of these attributes should have a value of 'true'. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / Customer | 1 | Detailed customer information for this profile. | |||||||||
| @VIP_Indicator | 0..1 | If true, indicates a very important person. | |||||||||
| @CustomerValue | 0..1 | The supplier's ranking of the customer (e.g., VIP, numerical ranking). | |||||||||
| @BirthDate | 0..1 | The customer’s birthday information. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / Customer / PersonName | 0..1 | Detailed name information for the customer. | |||||||||
| @Language | 0..1 | The language code for which the name data is represented. | |||||||||
| @NameType | 0..1 | Former, Nickname, Alternate, etc. Please refer to OpenTravel Code List Name Type (NAM). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / Customer / PersonName / NamePrefix | 0..3 | Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / Customer / PersonName / GivenName | 0..5 | Given name, first name or names. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / Customer / PersonName / MiddleName | 0..3 | The middle name of the person name. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / Customer / PersonName / Surname | 1 | Family or last name. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / Customer / PersonName / NameSuffix | 0..3 | Name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.) | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / Customer / PersonName / NameTitle | 0..5 | Degree or honours (e.g., Ph.D., M.D.) | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / Customer / Telephone | 0..5 | Information on a telephone number for the customer. | |||||||||
| @PhoneLocationType | 0..1 | Describes the location of the phone, such as Home, Office, Property Reservation Office, etc. Refer to OpenTravel Code List Phone Location Type (PLT). | |||||||||
| @PhoneTechType | 0..1 | Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT). | |||||||||
| @PhoneNumber | 1 | Telephone number assigned to a single location. | |||||||||
| @CountryAccessCode | 0..1 | Code assigned by telecommunications authorities for international country access identifier. | |||||||||
| @AreaCityCode | 0..1 | Code assigned for telephones in a specific region, city, or area. | |||||||||
| @FormattedInd | 0..1 | Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted. | |||||||||
| @DefaultInd | 0..1 | When true, indicates a default value should be used. | |||||||||
| @Remark | 0..1 | A remark associated with the telephone number. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / Customer / Email | 0..5 | Information on an email address for the customer. | |||||||||
| @EmailType | 0..1 | Defines the purpose of the e-mail address (e.g. personal, business, listserve). Refer to OpenTravel Code List Email Address Type (EAT). | |||||||||
| @DefaultInd | 0..1 | When true, indicates a default value should be used. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / Customer / Address | 0..5 | Detailed information on an address for the customer. | |||||||||
| @Type | 0..1 | Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / Customer / Address / AddressLine | 0..5 | These lines will contain free form address details. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / Customer / Address / CityName | 0..1 | City (e.g., Dublin), town, or postal station. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / Customer / Address / StateProv | 0..1 | State, province, or region name. | |||||||||
| @StateCode | 0..1 | The standard code or abbreviation for the state, province, or region. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / Customer / Address / PostalCode | 0..1 | Post Office Code number. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / Customer / Address / CountryName | 0..1 | Country name (e.g., Ireland). | |||||||||
| @Code | 0..1 | ISO 3166 code for a country. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / Customer / CustLoyalty | 0..n | Loyalty program information for the customer. | |||||||||
| @ProgramID | 0..1 | The ProgramID attribute can be used to indicate the program that is being passed. For instance, we could use it to pass: Frequent Guest, Frequent Traveller and Company ID. | |||||||||
| @MembershipID | 0..1 | The membershipID attribute will indicate the actual number. | |||||||||
| @LoyalLevel | 0..1 | Indicates special privileges in program assigned to individual. | |||||||||
| @LoyalLevelCode | 0..1 | Provides a numeric code assigned to a particular loyalty level. | |||||||||
| @EffectiveDate | 0..1 | Indicates the starting date of the program. | |||||||||
| @ExpireDate | 0..1 | Indicates the expiration date of the program. | |||||||||
| @SignupDate | 0..1 | Indicates the customer’s sign-up date. | |||||||||
| @Remark | 0..1 | A remark associated with the customer's loyalty program. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo | 0..1 | Detailed information about a company. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / CompanyName | 0..1 | Identifies a company by name. | |||||||||
| @Code | 0..1 | Identifies a company by the company code. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / AddressInfo | 0..5 | ||||||||||
| @Type | 0..1 | Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / AddressInfo / AddressLine | 0..5 | These lines will contain free form address details. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / AddressInfo / CityName | 0..1 | City (e.g., Dublin), town, or postal station. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / AddressInfo / StateProv | 0..1 | State, province, or region name. | |||||||||
| @StateCode | 0..1 | The standard code or abbreviation for the state, province, or region. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / AddressInfo / PostalCode | 0..1 | Post Office Code number. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / AddressInfo / CountryName | 0..1 | Country name (e.g., Ireland). | |||||||||
| @Code | 0..1 | ISO 3166 code for a country. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / TelephoneInfo | 0..n | Information on a telephone number for the company. | |||||||||
| @PhoneLocationType | 0..1 | Describes the location of the phone, such as Home, Office, Property Reservation Office, etc. Refer to OpenTravel Code List Phone Location Type (PLT). | |||||||||
| @PhoneTechType | 0..1 | Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT). | |||||||||
| @PhoneNumber | 1 | Telephone number assigned to a single location. | |||||||||
| @CountryAccessCode | 0..1 | Code assigned by telecommunications authorities for international country access identifier. | |||||||||
| @AreaCityCode | 0..1 | Code assigned for telephones in a specific region, city, or area. | |||||||||
| @FormattedInd | 0..1 | Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted. | |||||||||
| @DefaultInd | 0..1 | When true, indicates a default value should be used. | |||||||||
| @Remark | 0..1 | A remark associated with the telephone number. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / Email | 0..5 | Information on an email address for the company. | |||||||||
| @EmailType | 0..1 | Defines the purpose of the e-mail address (e.g. personal, business, listserve). Refer to OpenTravel Code List Email Address Type (EAT). | |||||||||
| @DefaultInd | 0..1 | When true, indicates a default value should be used. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson | 0..n | Information on a contact person for the company. Name of an individual and appropriate contact information. May be contact information for the customer or someone affiliated with the customer. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / PersonName | 0..n | ||||||||||
| @Language | 0..1 | The language code for which the name data is represented. | |||||||||
| @NameType | 0..1 | Former, Nickname, Alternate, etc. Please refer to OpenTravel Code List Name Type (NAM). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / PersonName / NamePrefix | 0..3 | Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / PersonName / GivenName | 0..5 | Given name, first name or names. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / PersonName / MiddleName | 0..3 | The middle name of the person name. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / PersonName / Surname | 1 | Family or last name. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / PersonName / NameSuffix | 0..3 | Name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.) | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / PersonName / NameTitle | 0..5 | Degree or honours (e.g., Ph.D., M.D.) | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / Telephone | 0..5 | Information on a telephone number for the customer. | |||||||||
| @PhoneLocationType | 0..1 | Describes the location of the phone, such as Home, Office, Property Reservation Office, etc. Refer to OpenTravel Code List Phone Location Type (PLT). | |||||||||
| @PhoneTechType | 0..1 | Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT). | |||||||||
| @PhoneNumber | 1 | Telephone number assigned to a single location. | |||||||||
| @CountryAccessCode | 0..1 | Code assigned by telecommunications authorities for international country access identifier. | |||||||||
| @AreaCityCode | 0..1 | Code assigned for telephones in a specific region, city, or area. | |||||||||
| @FormattedInd | 0..1 | Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted. | |||||||||
| @DefaultInd | 0..1 | When true, indicates a default value should be used. | |||||||||
| @Remark | 0..1 | A remark associated with the telephone number. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / Address | 0..5 | Detailed information on an address for the contact person for the company. | |||||||||
| @Type | 0..1 | Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / Address / AddressLine | 0..5 | These lines will contain free form address details. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / Address / CityName | 0..1 | City (e.g., Dublin), town, or postal station. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / Address / StateProv | 0..1 | State, province, or region name. | |||||||||
| @StateCode | 0..1 | The standard code or abbreviation for the state, province, or region. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / Address / PostalCode | 0..1 | Post Office Code number. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / Address / CountryName | 0..1 | Country name (e.g., Ireland). | |||||||||
| @Code | 0..1 | ISO 3166 code for a country. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / CompanyInfo / ContactPerson / Address / CountryName / Email | 0..5 | Information on an email address for the contact person for the company. | |||||||||
| @EmailType | 0..1 | Defines the purpose of the e-mail address (e.g. personal, business, listserve). Refer to OpenTravel Code List Email Address Type (EAT). | |||||||||
| @DefaultInd | 0..1 | When true, indicates a default value should be used. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / TotalCommissions | 0..1 | Contains details pertaining to commissions. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / TotalCommissions / UniqueID | 0..1 | Identifies the recipient of the commission. | |||||||||
| @ID | 1 | 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. | |||||||||
| @Type | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / TotalCommissions / CommissionPayableAmount | 0..1 | The amount of commission to be paid. | |||||||||
| @CurrencyCode | 0..1 | An ISO 4217 (3) alpha character code that specifies a monetary unit. | |||||||||
| @Amount | 0..1 | A monetary amount. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / TotalCommissions / Comment | 0..1 | ||||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / TotalCommissions / Comment / Text | 1 | Text related to the commission. | |||||||||
| OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / BasicPropertyInfo | 1 | Property information for the reservation. | |||||||||
| @ChainCode | 0..1 | The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. | |||||||||
| @BrandCode | 0..1 | A code that identifies the brand or flag of a hotel, often used for independently-owned or franchised properties who are known by a specific brand. | |||||||||
| @HotelCode | 1 | The code that uniquely identifies a single hotel property. The hotel code is decided between vendors. | |||||||||
| @HotelName | 0..1 | A text field used to communicate the proper name of the hotel. |
OTA_HotelResNotifRS
This message will be returned by pmsXchange in response to the OTA_HotelResNotifRQ message sent by partner PMS publishers. The message will confirms whether the OTA_HotelResNotifRQ message was processed successfully by pmsXchange or not.
OTA_HotelResNotifRS Specification
Elements and attributes marked with Number=1 or more are mandatory and will always be sent. 0..n means that the element or attribute is optional.
| Element | @Attribute | Num | Description / Contents |
|---|---|---|---|
| OTA_HotelResNotifRS | 1 | Root element of the message. | |
| @EchoToken | 1 | As per OpenTravel Alliance Specifications. | |
| @Version | 1 | Version is a mandatory attribute in OTA; therefore, it must remain Mandatory in HTNG in order to be able to use the same message. | |
| @TimeStamp | 1 | Time of the transaction. | |
| @ResResponseType | 0..1 | Given that the OTA_HotelResNotifRQ message is used for additions, modifications and cancellations, this attribute is used to replicate whether the original message was an addition, a modification or a cancellation and does not refer to the status of the transaction itself but rather to the nature of the original message. The only three enumerations allowed will therefore be: Committed, Modified and Cancelled. In this case Committed would be used. | |
| OTA_HotelResNotifRS / Errors / Error | 1..99 | Mandatory ONLY if Success element is not sent. Only needed if RQ message was unsuccessful. | |
| @Type | 1 | Mandatory in OTA. Refers to OpenTravel Alliance EWT list (error warning type). | |
| @Code | 0..1 | Refers to OpenTravel Alliance list ERR. Should be used wherever possible. | |
| @RecordID | 0..1 | If the receiving system is able to identify within a batch of reservations which reservation failed, the uniqueID of the rejected reservation should be reported here. | |
| OTA_HotelResNotifRS / Success | 1 | Mandatory if no Errors were sent. This is the annotation that the reservation batch was received successfully. It could be combined with warning messages if some of the reservations in the batch had issues. | |
| OTA_HotelResNotifRS / Warnings / Warning | 0..99 | Can be used in conjunction with Success message. | |
| @Type | 1 | Refers to OpenTravel Alliance EWT list (error warning type). | |
| @Code | 0..1 | Refers to OpenTravel Alliance list ERR. Should be used wherever possible. | |
| @RecordID | 0..1 | If the receiving system is able to identify within a batch of reservations which reservation has a warning, the uniqueID of that reservation should be reported here. | |
| OTA_HotelResNotifRS / HotelReservations / HotelReservation | 1 | Must be sent for the message to have a meaning. | |
| @ResStatus | 0..1 | Indicates the current status of the reservation. Valid values are dependant on the roles: Reserved Waitlisted In-house Checked-Out | |
| OTA_HotelResNotifRS / HotelReservations / HotelReservation / UniqueID | 1 | This is the confirmation number for the reservation assigned by the immediate originator of the booking (i.e., the system that sent the OTA_HotelResNotifRQ message for which the OTA_HotelresNotifRS message is sent). | |
| @Type | 0..1 | Type is assigned values from the UIT code list. If the original system was a CRS: Type = 14 – Reservation ID is the actual confirmation number If it was a PMS: Type = 10 - Hotel | |
| @ID | 1 | ID is the CRS confirmation number (or PMS number if the reservation was originated in the PMS). |
OTA_HotelResNotifRS Sample
OTA_HotelResNotifRS - Success
<OTA_HotelResNotifRS xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="879791900" TimeStamp="2014-01-26T19:31:02-05:00" Version="1.001" ResResponseType="Modified">
<Success/>
<HotelReservations>
<HotelReservation>
<UniqueID Type="14" ID="3741" />
</HotelReservation>
</HotelReservations>
</OTA_HotelResNotifRS>
OTA_HotelResNotifRS - Failure
<OTA_HotelResNotifRS xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="879791900" TimeStamp="2014-01-26T19:31:02-05:00" Version="1.001" ResResponseType="Modified">
<Errors>
<Error Type="5">Authentication timed out</Error>
</Errors>
<HotelReservations>
<HotelReservation>
<UniqueID Type="14" ID="3741" />
</HotelReservation>
</HotelReservations>
</OTA_HotelResNotifRS>