OTA_HotelResNotifRQ
- Martin Mahony
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 |
Sample
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.opentravel.org/OTA/2003/05" xmlns:oas="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<soapenv:Header>
<HTNGHeader xmlns="http://htng.org/1.1/Header/">
<From>
<systemId>Avvio</systemId>
<Credential>
<userName>dummy</userName>
<password>dummy</password>
</Credential>
</From>
<To>
<systemId>46</systemId>
</To>
<timeStamp>2024-05-30T09:33:23+00:00</timeStamp>
<echoToken>GL-40dYZiPnij53xgAAMSY=</echoToken>
<transactionId />
<action />
</HTNGHeader>
</soapenv:Header>
<soapenv:Body>
<OTA_HotelResNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Version="4" ResStatus="Book" EchoToken="GL-40dYZiPnij53xgAAMSY=" TimeStamp="2024-05-30T09:33:23+00:00">
<HotelReservations>
<HotelReservation RoomStayReservation="true" CreateDateTime="2024-05-30T09:09:03+00:00" CreatorID="AvvioC5">
<UniqueID Type="14" ID="3QFNLAV" ID_Context="CrsConfirmNumber" />
<RoomStays>
<RoomStay MarketCode="OWNWEB">
<RoomTypes>
<RoomType RoomTypeCode="FAM" NumberOfUnits="1" IsRoom="true">
<RoomDescription Name="FAM">Family Room 2+2</RoomDescription>
</RoomType>
</RoomTypes>
<RatePlans>
<RatePlan RatePlanCode="BARRO" EffectiveDate="2024-07-01" ExpireDate="2024-07-02">
<RatePlanDescription Name="BARRO">Best Available Rate Room Only</RatePlanDescription>
<Commission>
<CommissionPayableAmount Amount="20.22" CurrencyCode="EUR" />
</Commission>
</RatePlan>
</RatePlans>
<RoomRates>
<RoomRate RoomTypeCode="FAM" RatePlanCode="BARRO" NumberOfUnits="1">
<Rates>
<Rate EffectiveDate="2024-07-01" ExpireDate="2024-07-01" RateTimeUnit="Day" UnitMultiplier="1">
<Base AmountBeforeTax="215.00" AmountAfterTax="215.00" CurrencyCode="EUR" />
</Rate>
<Rate EffectiveDate="2024-07-02" ExpireDate="2024-07-02" RateTimeUnit="Day" UnitMultiplier="1">
<Base AmountBeforeTax="215.00" AmountAfterTax="215.00" CurrencyCode="EUR" />
</Rate>
</Rates>
</RoomRate>
</RoomRates>
<GuestCounts IsPerRoom="1">
<GuestCount AgeQualifyingCode="10" Count="2" />
<GuestCount AgeQualifyingCode="8" Count="1" />
<GuestCount AgeQualifyingCode="7" Count="1" />
</GuestCounts>
<TimeSpan Start="2024-07-01" End="2024-07-02" />
<DepositPayments>
<RequiredPayment>
<AcceptedPayments>
<AcceptedPayment>
<PaymentCard CardType="CREDITCARD" />
</AcceptedPayment>
</AcceptedPayments>
<AmountPercent Amount="50.00" CurrencyCode="EUR" />
<PaymentDescription CreatorID="AVVIO" />
</RequiredPayment>
</DepositPayments>
<Guarantee />
<Total AmountBeforeTax="430.00" AmountAfterTax="430.00" CurrencyCode="EUR">
<Taxes Amount="0.00" CurrencyCode="EUR" />
</Total>
<BasicPropertyInfo HotelCode="1853" HotelName="TestHotel Mahony" />
<ResGuestRPHs>
<ResGuestRPH RPH="0" />
</ResGuestRPHs>
<Comments>
<Comment Name="GuestRequest" GuestViewable="1">
<Text />
</Comment>
<Comment Name="Internal Notes" GuestViewable="0">
<Text>NOTE: PROCESS CARD IN CURRENCY OF CARD HOLDER</Text>
</Comment>
</Comments>
<ServiceRPHs>
<ServiceRPH RPH="1" />
<ServiceRPH RPH="2" />
<ServiceRPH RPH="3" />
<ServiceRPH RPH="4" />
<ServiceRPH RPH="5" />
</ServiceRPHs>
</RoomStay>
</RoomStays>
<Services>
<Service ServiceRPH="1" ServiceCategoryCode="AVVIO" ServiceInventoryCode="1to1" Quantity="1">
<Price>
<Base AmountAfterTax="50.00" CurrencyCode="EUR" />
</Price>
<ServiceDetails>
<Comments>
<Comment Name="Title">
<Text>Private 1 to 1 Instruction (EUR 50.00 x 2 adults)</Text>
</Comment>
</Comments>
</ServiceDetails>
</Service>
<Service ServiceRPH="2" ServiceCategoryCode="AVVIO" ServiceInventoryCode="TEA2" Quantity="1">
<Price>
<Base AmountAfterTax="27.00" CurrencyCode="EUR" />
</Price>
<ServiceDetails>
<Comments>
<Comment Name="Title">
<Text>Afternoon Tea at 14:00 (EUR 27.00 x 2 adults)</Text>
</Comment>
</Comments>
</ServiceDetails>
</Service>
<Service ServiceRPH="3" ServiceCategoryCode="AVVIO" ServiceInventoryCode="REDW" Quantity="3">
<Price>
<Base AmountAfterTax="30.00" CurrencyCode="EUR" />
</Price>
<ServiceDetails>
<Comments>
<Comment Name="Title">
<Text>Whispering Angel Rosé (EUR 30.00 each)</Text>
</Comment>
</Comments>
</ServiceDetails>
</Service>
<Service ServiceRPH="4" ServiceCategoryCode="AVVIO" ServiceInventoryCode="eci" Quantity="1">
<Price>
<Base AmountAfterTax="40.00" CurrencyCode="EUR" />
</Price>
<ServiceDetails>
<Comments>
<Comment Name="Title">
<Text>Early Checkin from 13:00</Text>
</Comment>
</Comments>
</ServiceDetails>
</Service>
<Service ServiceRPH="5" ServiceCategoryCode="AVVIO" ServiceInventoryCode="lco" Quantity="1">
<Price>
<Base AmountAfterTax="30.00" CurrencyCode="EUR" />
</Price>
<ServiceDetails>
<Comments>
<Comment Name="Title">
<Text>Late Checkout until 13:00</Text>
</Comment>
</Comments>
</ServiceDetails>
</Service>
</Services>
<ResGuests>
<ResGuest ResGuestRPH="0">
<Profiles>
<ProfileInfo>
<Profile ProfileType="1">
<Customer>
<PersonName>
<GivenName>Luke</GivenName>
<Surname>Skywalker</Surname>
<NamePrefix>Mr</NamePrefix>
</PersonName>
<Telephone PhoneTechType="1" PhoneNumber="+353 61335680" />
<Email DefaultInd="1">martin.mahony@shrgroup.com</Email>
</Customer>
</Profile>
</ProfileInfo>
</Profiles>
</ResGuest>
</ResGuests>
<ResGlobalInfo>
<Guarantee GuaranteeCode="AVVIOPAR" GuaranteeType="Deposit" />
<Total AmountBeforeTax="744.00" AmountAfterTax="744.00" CurrencyCode="EUR">
<Taxes Amount="0.00" CurrencyCode="EUR" />
</Total>
<Comments />
<Profiles>
<ProfileInfo>
<Profile ProfileType="21" OptInStatus="OptedIn">
<Customer>
<PersonName>
<GivenName>Martin</GivenName>
<Surname>Mahony</Surname>
<NamePrefix>Mr</NamePrefix>
</PersonName>
<Telephone PhoneTechType="1" PhoneNumber="+353 61335680" />
<Email DefaultInd="1">martin.mahony@shrgroup.com</Email>
<Address Type="1">
<AddressLine>Avvio House, Lonsdale Road National Technology Park</AddressLine>
<CityName>Castletroy</CityName>
<PostalCode>V94 AW2X</PostalCode>
<StateProv>Limerick</StateProv>
<CountryName Code="IE">IE</CountryName>
</Address>
</Customer>
<TPA_Extensions>
<PreStay OptInStatus="OptedIn" />
<PostStay OptInStatus="OptedIn" />
</TPA_Extensions>
</Profile>
</ProfileInfo>
</Profiles>
</ResGlobalInfo>
<TPA_Extensions>
<SourceOfBusiness>OWNWEB</SourceOfBusiness>
</TPA_Extensions>
</HotelReservation>
</HotelReservations>
</OTA_HotelResNotifRQ>
</soapenv:Body>
</soapenv:Envelope>Response
Element / @Attribute | Quantity | Type | Description |
OTA_HotelResNotifRS | 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 |
@ResResponseType | 0..1 | String | An enumerated attribute that contains the status of the processing of the requested hotel reservations |
Success | 0..1 |
| Indicates that the incoming request message was processed successfully |
Errors | 0..1 |
| A collection of errors that occurred during the processing of a message |
Warnings | 0..1 |
| A collection of warning that occurred during the processing of a message |
HotelReservation | 1 |
| Contains a hotel reservation |
ResGlobalInfo | 0..1 |
| ResGlobalInfo is a container for various information that affects the Reservation as a whole |
HotelReservationIDs | 0..1 |
| A Collection of HotelReservationID objects for a given reservation |
HotelReservationID | 1 |
| 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 | Integer | Defines the type of Reservation |
@ResID_Value | 1 | String | This is the actual value associated with ResID_Type. |
POS | 0..1 |
| Identifies who made the original reservation |
Sample
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<OTA_HotelResNotifRS xmlns="http://www.opentravel.org/OTA/2003/05">
<Success />
<HotelReservations>
<HotelReservation>
<UniqueID ID="3QFNLAV" ID_Context="CrsConfirmNumber" Type="14" />
<ResGlobalInfo>
<HotelReservationIDs>
<HotelReservationID ResID_SourceContext="PmsConfirmNumber" ResID_Type="14" ResID_Value="RL34403589" />
</HotelReservationIDs>
</ResGlobalInfo>
</HotelReservation>
</HotelReservations>
</OTA_HotelResNotifRS>
</soap:Body>
</soap:Envelope>