| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Overview
The OTA_HotelResNotifRQ operation is used to transmit a hotel reservation to a third party system.
Request
Element / @Attribute | Quantity | Type | Description |
OTA_HotelResNotifRQ | 1 | Root element | |
@TimeStamp | 0..1 | DateTime | ISO 8601 encoded timestamp indicating the creation date and time of the message |
@EchoToken | 0..1 | String | A reference for additional message identification, assigned by the requesting host system |
@Version | 0..1 | Decimal | The OpenTravel message version indicated by a decimal value |
@ResStatus | 1 | String | To specify the type of action requested when more than one function could be handled by the message |
HotelReservations | 0..1 | A collection of hotel reservations | |
HotelReservation | 1 | ||
@RoomStayReservation | 0..1 | Boolean | Boolean True if this reservation is reserving rooms |
@CreateDateTime | 0..1 | DateTime | Time stamp of the creation |
@CreatorID | 0..1 | String | ID of creator |
UniqueID | 0..1 | The unique identifier element allows the trading partners to uniquely identify each Rate being uploaded | |
@Type | 1 | Integer | A reference to the type of object defined by the UniqueID element. |
@ID | 1 | String | A unique identifying value assigned by the creating system |
@ID_Context | 0..1 | String | Used to identify the source of the identifier |
RoomStays | 0..1 | Collection of room stays | |
RoomStay | 1 | Details on the Room Stay | |
@MarketCode | 0..1 | The code that relates to the market being sold | |
RoomTypes | 1 | A collection of Room Types associated with a particular Room Stay | |
RoomType | 1 | Provides details of a RoomType | |
@RoomTypeCode | 1 | String | Specific system room type code |
@NumberOfUnits | 1 | Integer | The number of units of this room type associated with this booking |
@IsRoom | 0..1 | Boolean | Indicates the room is a sleeping room when true |
RoomDescription | 0..1 | String | Textual information regarding the room. |
@Name | 1 | String | Used to transmit the room code of the room in the Avvio system |
RatePlans | 1 | A collection of Rate Plans associated with a particular Room Stay | |
RatePlan | 1 | Defines the details of the rate plan related to the reservations | |
@RatePlanCode | 1 | String | A code that identifies the rate plan |
@EffectiveDate | 1 | Date | Indicates the starting date |
@ExpireDate | 1 | Date | Indicates the ending date |
RatePlanDescription | 0..1 | Describes the rate plan | |
@Name | 1 | String | Used to transmit the room code of the room in the Avvio system |
Commission | 0..1 | Commission associated with the RatePlan | |
CommissionPayableAmount | 0..1 | The amount of commission to be paid | |
@Amount | 0..1 | Decimal | A monetary amount |
@CurrencyCode | 1 | String | Specifies the currency code |
RoomRates | 0..1 | A collection of Room Rates associated with a particular Room Stay | |
RoomRate | 1 | Defines the details of the room rate related with the reservation | |
@RoomTypeCode | 1 | String | A code that identifies a room type |
@RatePlanCode | 1 | String | A code that identifies the rate plan |
@NumberOfUnits | 1 | Integer | The number of units of this room type associated with this booking |
Rates | 0..1 | Individual rate amount | |
Rate | 1 | The Rate contains a collection of elements that define the amount of the rate | |
@EffectiveDate | 1 | Date | Indicates the starting date |
@ExpireDate | 1 | Date | Indicates the ending date |
@RateTimeUnit | 1 | String | Indicates the time unit for the rate |
@UnitMultiplier | 1 | IntegervIndicates the number of rate time units | |
Base | The base amount charged for the accommodation or service per unit of time | ||
@AmountAfterTax | 1 | Decimal | The total amount including all associated taxes |
@CurrencyCode | 1 | String | Specifies the currency code |
GuestCounts | 1 | A collection of GuestCount by age group | |
@IsPerRoom | 1 | Boolean | IsPerRoom means that the guests defined in the GuestCounts object apply to each room in the NumberOfRooms for the RoomStay |
GuestCount | 1 | Identifies the number of guests and ages of the guests | |
@AgeQualifyingCode | 1 | Decimal | Defines an age range or age category of a guest |
@CurrencyCode | 1 | String | Specifies the currency code |
TimeSpan | 0..1 | The Time Span which covers the Room Stay | |
@Start | 1 | Date | The starting value of the time span |
@End | 1 | Date | The ending value of the time span |
Total | 1 | The total amount charged for the room stay | |
@AmountBeforeTax | 1 | Decimal | The total amount not including any associated tax |
@AmountAfterTax | 1 | Decimal | The total amount including all associated taxes |
@CurrencyCode | 1 | String | Specifies the currency code |
Taxes | 0..1 | A collection of taxes | |
@Amount | 1 | Decimal | The monetary tax amount |
@CurrencyCode | 1 | String | Specifies the currency code |
BasicPropertyInfo | 0..1 | Property Information for the Room Stay | |
@HotelCode | 1 | String | The code that uniquely identifies a single hotel property |
@HotelName | 0..1 | String | A text field used to communicate the proper name of the hotel |
ReGuestRPHs | 0..1 | A collection of unsigned integers serving as reference placeholders, and used as an index identifying which guests occupy this room | |
ResGuestRPH | 1 | An individual ResGuestRPH | |
@RPH | 1 | Integer | Integer index of the ResGuest object |
Comments | 0..1 | A collection of Comment | |
Comment | 1 | An individual comment | |
@Name | 1 | String | Name of the comment |
@GuestViewable | 1 | Boolean | When true, the comment may be shown to the consumer. When false, the comment may not be shown to the consumer |
Text | 1 | String | Textual detais of comment |
ServiceRPHs | 0..1 | A collection of unsigned integers that reference the attribute in the Service object | |
ServiceRPH | 1 | An individual ServiceRPH | |
@RPH | 1 | Integer | Integer index of the ServiceRPH |
Services | 0..1 | This is the collection of all services associated with any part of this reservation. Which services are attributable to which part is determined by each object's ServiceRPHs collection | |
Service | 1 | A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges | |
@ServiceRPH | 1 | Integer | A unique ID for a service that may be referenced elsewhere in the schema |
@ServiceInventoryCode | 1 | String | The representation of the specific service being reserved |
@Quantity | The number of units of the service applied to the reservation | ||
Price | 1 | The selling price of this Service | |
Base | 1 | The base amount charged for the service per unit of time | |
@AmountAfterTax | 1 | Decimal | The total amount including all associated taxes |
@CurrencyCode | 1 | String | Specifies the currency code |
ServiceDetails | 0..1 | Details on the Service | |
Comments | 0..1 | A collection of Comment | |
Comment | 1 | An individual comment | |
@Name | 1 | String | Name of the comment |
Text | 1 | String | Textual detais of comment |
ResGuests | 0..1 | 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 | |
ResGuest | 1 | The ResGuest object contains the information about a guest associated with a reservation | |
@ResGuestRPH | 1 | Integer | This is a reference placeholder, used as an index for this guest in this reservation |
Profiles | 0..1 | A collection of Profile objects | |
ProfileInfo | 1 | A collection of Profile objects | |
Profile | 1 | Provides detailed information regarding a customer profile | |
@ProfileType | 1 | Integer | Code to specify a profile |
Customer | 0..1 | Detailed customer information for this profile | |
PersonName | 0..1 | Detailed name information for the customer | |
GivenName | 0..1 | StringvGiven name, first name or names | |
SurName | 1 | String | Family name, last name |
NameTitle | 0..1 | String | Salutation or honorific |
Telephone | 0..1 | Information on a telephone number for the customer | |
@PhoneTechType | 1 | Integer | Indicates type of technology associated with this telephone number |
@PhoneNumber | 1 | String | Telephone number assigned to a single location |
0..1 | String | Information on an email address for the customer | |
@DefaultInd | 1 | Boolean | When true, indicates a default value should be used |
ResGlobalInfo | 1 | ResGlobalInfo is a container for various information that affects the Reservation as a whole | |
Guarantee | 1 | The guarantee information associated to the Reservation or a particular Room Stay or Service | |
@GuaranteeCode | 1 | String | Guarantee Code |
@GuaranteeType | 1 | String | Guarantee Type |
GuaranteesAccepted | 0..1 | A collection of guarantees accepted | |
GuaranteeAccepted | 1 | Details of an accepted guarantee | |
PaymentCard | 1 | Details of a debit or credit card used to guarantee the booking | |
@CardType | 1 | Integer | Payment card type |
@CardCode | 1 | String | Payment card issuer code |
@CardNumber | 1 | StringvPayment card number | |
@ExpireDate | Payment card expiry date | ||
CardHolderName | 1 | String | Card holder name |
Total | 1 | The total amount charged for the room stay | |
@AmountBeforeTax | 1 | Decimal | The total amount not including any associated tax |
@AmountAfterTax | 1 | Decimal | The total amount including all associated taxes |
@CurrencyCode | 1 | String | Specifies the currency code |
Taxes | 0..1 | A collection of taxes | |
@Amount | 1 | Decimal | The monetary tax amount |
@CurrencyCode | 1 | String | Specifies the currency code |
Profiles | 0..1 | A collection of Profile objects | |
ProfileInfo | 1 | A collection of Profile objects | |
Profile | 1 | Provides detailed information regarding a customer profile | |
@ProfileType | 1 | Integer | Code to specify a profile |
@OptInStatus | 1 | String | Status of the opt in |
Customer | 0..1 | Detailed customer information for this profile | |
PersonName | 0..1 | Detailed name information for the customer | |
GivenName | 0..1 | String | Given name, first name or names |
SurName | 1 | String | Family name, last name |
NameTitle | 0..1 | StringvSalutation of honorific | |
Telephone | 0..1 | Information on a telephone number for the customer | |
@PhoneTechType | 1 | Integer | Indicates type of technology associated with this telephone number |
@PhoneNumber | 1 | String | Telephone number assigned to a single location |
0..1 | String | Information on an email address for the customer | |
@DefaultInd | 1 | Boolean | When true, indicates a default value should be used |
Address | 0..1 | Detailed information on an address for the customer | |
@Type | 1 | Integer | Defines the type of address |
AddressLine | 0..1 | String | Main line of address |
CityName | 0..1 | String | Address city |
StateProv | 0..1 | String | Adress State or Province |
CountryName | 0..1 | String | Address Country |
@Code | 0..1 | String | ISO 3166 code for a country |
TPA_Extensions | 0..1 | A placeholder in the schema to allow for additional elements and attributes to be included per Trading Partner Agreement | |
SourceOfBusiness | 0..1 | String | Source of business that generated the reservation |
...