Element/@Attribute
Parent XPath
| **Description** | **Occurrences** | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | |@TimeStamp
/OTA\_HotelResNotifRQ
|
Time of the transaction in xml schema date-time format
| 1 | |@Version
/OTA\_HotelResNotifRQ
| The OTA schema version. Mandatory. Always set to“1.003” | 1 | |@ResStatus
/OTA\_HotelResNotifRQ
|To specify the type of action requested. Will be one of:
• “Commit” ->New reservation
• “Modify” -> Modification
• “Cancel” → Cancellation
|1
POS
/OTA\_HotelResNotifRQ
|Indicating the channel from which booking is received.
A simple source record would look like this:
\
\
\
\
\
\
\
This indicates that the reservation received from the OTA “Famous OTA” whose RG Bridge code is LTA1.
| 1 | |Source
/OTA\_HotelResNotifRQ/POS
|Provides information on the source
of a request.
|1
BookingChannel
/OTA\_HotelResNotifRQ/POS/Source
| Specifies the booking channel type and whether it is the primary means of connectivity of the source. |1
CompanyName
/OTA\_HotelResNotifRQ/POS/Source/
|
Contains the name of the channel
1
@Code
/OTA\_HotelResNotifRQ/POS/Source/
BookingChannel/CompanyName
| Contain code for the channel from which RezGain receives the booking. A list of OTA channels will be agreed between RG and PMS. | 1 | |HotelReservations
/OTA\_HotelResNotifRQ
| Contains 1 or more instance of hotel reservations. RG will only send one reservation in one message. | 1 | |HotelReservation
/OTA\_HotelResNotifRQ/HotelReservations
|
Reservation record
| 0…1 | |@CreateDateTime
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation
|Time of Booking
Time of the Booking in UTC format
| 1 | |@LastModifiedDateTime
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation
| Last updated time of booking in UTC format | 0..1 | |@ResStatus
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation
|Reservation Status. Since only one reservation record is sent in a message, the ResStatus at the
message level and at the reservation level will both be same.
Tospecifythetypeof action requested.
Will be one of:
• “Commit” -> New reservation
• “Modify” -> Modification
• “Cancel” ->Cancellation
@CreatorID
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation
| The CreatorID is the identifier of the user or, in its absence, the office that originated the reservation. | 0..1 | |BasicPropertyInfo
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/
| Property Information for the reservation. An abbreviated short summary of hotel descriptive information. | 1 | |@HotelCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/BasicPropertyInfo
|
Hotel Code for this reservation. Will be PMS/CRS partner hotel code.
| 1 | |UniqueID
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation
|
An identifier used to uniquely identify a booking confirmation number
| 1 | |@Type
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/UniqueID
|Unique ID type
Always set to 14
@ID
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/UniqueID
|
Unique Booking created in the source OTA channel
| 1 | |RoomStays
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation
| Contains 1 or more RoomStay elements. Allowed only 1 RoomStay element if the partner is working on split mode reservation delivery. | 1 | |RoomStay
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays
|
A Room stay details.
| 1..n | |RatePlans
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay
|
Contains ratePlan element associated with this room stay.
| 1 | |RatePlan
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/RatePlans
|
Details of a particular RatePlan
| 1 | |@RatePlanCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/RoomRates/
RoomRate
| Used to pass OTA/ Channel specific RatePlanCode booked in this RoomStay and not the RatePlanCode configured in CRS/PMS system. You may ignore it, if not required. | 1 | |RoomRates
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay
| Contains RoomRate elements associated with this room stay. | 1 | |RoomRate
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/RoomRates
|
A Room Rate element
| 1 | |@RoomTypeCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/RoomRates/
RoomRate
|
Room type code of this room stay in CRS/PMS system.
| 1 | |@NumberOfUnits
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/RoomRates/
RoomRate
|
This is the number of rooms booked for the room type listed in the RoomTypeCode attribute
| 1 | |@RatePlanCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/RoomRates/
RoomRate
|
Rate type code of this room stay
| 1 | |Rates
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/RoomRates/
RoomRate
|
Contains one or more Rate elements
| 1 | |Rate
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/RoomRates/
RoomRate/Rates
|
Rate details for each of the Stay Dates
| 1..n | |
@EffectiveDate
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/RoomRates/
RoomRate/Rates/Rate
|The EffectiveDate attribute indicates the start of the date range for which this specific rate is applied. A RoomStay could have different rates applied for different stay dates.
EffectiveDate and ExpireDate of each rate element together define for which dates of the stay that rate is applicable
| 1 | |@ExpireDate
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/RoomRates/
RoomRate/Rates/Rate
| The ExpireDate attribute indicates the end of the date range for which this specific rate is applied. | 1 | |@ RateTimeUnit
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/RoomRates/
RoomRate/Rates/Rate
|
Indicates the unit of time. Should always be “Day”.
| 1 | |@UnitMultiplier
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/RoomRates/
RoomRate/Rates/Rate
|
UnitMultiplier indicates how many days the rate is applicable for. Always set to “1”
| 1 | |Base
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/RoomRates/
RoomRate/Rates/Rate
|
The base amount charged for the accommodation or service per unit of time
| 1 | |@CurrencyCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/RoomRates/
RoomRate/Rates/Rate/Base
|
Indicates the currency of the rate.
| 1 | |@AmountBeforeTax
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/RoomRates/
RoomRate/Rates/Rate/Base
|Base Amount before Tax.
Either AmountBeforeTax or AmountAfterTax must be present
| 0..1 | |@AmountAfterTax
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/RoomRates/
RoomRate/Rates/Rate/Base
|Amount including tax.
Either AmountBeforeTax or AmountAfterTax must be present
| 0..1 | |GuestCounts
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay
|
Contains the guest counts of the room stay
| 1 | |GuestCount
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/GuestCounts
| Contains the type and number of guests included in the room stay. Will be repeated for each guest type: Adult and Child | 1..2 | |@AgeQualifyingCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/GuestCounts/
|RG Bridge supports the following values:
10 = Adult
| 1 | |@Count
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/GuestCounts/
GuestCount
|
Guest Count
| 1 | |TimeSpan
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay
| The Time Span which covers the Room Stay. Used to specify a time window range by specifying an earliest and latest date for the start date and end date. | 1 | |@Start
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/
RoomStay/TimeSpan
|
Check-in date for this room stay
| 1 | |@End
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/
RoomStay/TimeSpan
|
Check-out date for this room stay
| 1 | |Total
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay
|
The total amount charged for the Room Stay
| 1 | |@CurrencyCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/Total
|
Indicates the currency of the total
| 1 | |@AmountBeforeTax
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/Total
|Total amount excluding tax.
Either AmountBeforeTax or AmountAfterTax must be present
| 0..1 | |@AmountAfterTax
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/Total
|Total amount including tax.
Either AmountBeforeTax or AmountAfterTax must be present
| 0..1 | |Taxes
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/Total
|
Contains taxes and surcharges information, if any.
| 0..1 | |Tax
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/Total/Taxes
|
Tax or surcharge information
| 1 | |@Type
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/Total/Taxes/Tax
| Indicates whether the tax is inclusive, exclusive, or cumulative | 1 | |@Code
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/Total/Taxes/Tax
|Used to indicate the specific tax or fee that is being transferred.
Code that specifies the type of tax:
16 = surcharge
17 = Total tax.
| 1 | |@CurrencyCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/Total/Taxes/Tax
| Currency of the total Amount of Taxes | 1 | |@ Amount
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/Total/Taxes/Tax
| Amount of the specific tax/fee transferred | 1 | |Memberships
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay
| A collection of Membership objects. Memberships provides a list of reward programs which may be credited with points accrued from the guest's activity. | 0..1 | |Membership
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/Memberships
| The Selected Membership object identifies the frequent customer reward program and (optionally) indicates points awarded for stay activity. | 0..1 | |/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/Memberships/
Membership
| The account identification number for this particular member in this particular program. | 0..1 | |/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/Memberships/
Membership
| The total number of points earned through the selected membership. | 0..1 | |/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/Memberships/
Membership
| The code or name of the membership program ('Hertz', 'AAdvantage', etc.). |0..1
| |/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/Memberships/
Membership
|Identifies the travel sector. Refer to OpenTravel Code List Travel Sector (TVS).
|0..1
Comments
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/
|A collection of comments
0..1
Comment
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/Comments
| A comment which applies to the room stay. A comment can either be guest viewable or not. |1
@GuestViewable
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/Comments/Comment
1
Text
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/Comments/Comment
|Comment text
1
| |SpecialRequests
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/
| Contains SpecialRequest elements. The SpecialRequest object indicates special requests for a particular Room Stay. The collection of all specialrequests associated with any part of the reservation (the reservation in its entirety, one or more guests, or one or more room stays). Which special requests belong to which part is determined by each object's SpecialRequestRPHs collection. | 0..1 | |SpecialRequest
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/SpecislRequests
| If SpecialRequests element is present, at least 1 SpecialRequest must be present. | 1 | |@RequestCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/SpecislRequests/
SpecialRequest
|Optional, contains the code of the Special Request. It could be:
Smoking
Non-Smoking
If not present, the text of the Special Request to be added to child element \
Text
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/SpecislRequests/SpecialRequest
| Optional, contains the text of the Special Request if \/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay
|An integer serving as reference placeholders, and used as an index identifying which guests occupy this
room
| 1 | |/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay
| A collection of unsigned integers that reference the RPH (Reference Place holder) attribute in the Service object. The ServiceRPH attribute in the Service object is an indexing attribute that identifies the services attached to this room stay. | 0..1 | |ResGuests
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation
| Contains guest information elements. Will always contain at least one element with the primary guest information. | 1 | |ResGuest
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests
|At least one guest-information will be sent. May optionally contain additional guest information. Used to pass different guest profile info
i.e. canbeguest, TravelAgent, COmpamny profile details.
| 1..n | |@AgeQualifyingCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest
|RGBridge supports the following values:
10=Adult 8=Child
| 1 | |@PrimaryIndicator
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest
| Will be true for primary guest. Only one ResGuest element in the ResGuests container will have the value of primary indicator set to true. | 1 | |@ArrivalTime
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest
| This represents the date and time of the guest's arrival at the hotel. For example, this could be used to indicate a late arrival. | 0..1 | |@DepartureTime
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest
| This represents the date and time of the guest's arrival at the hotel. For example, this could be used to indicate a latearrival. | 0..1 | |
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest
| This is a reference placeholder, used as an index for this guest in this reservation. It is used by the RoomStay and Service objects to indicate which guests are associated with that room stay or service. | 1 | |Profiles
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest
|Mandatory for the primary guest and optional for other guests.
1
ProfileInfo
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles
|Only one ProfileInfo element is allowed for each guest
1
UniqueID
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo
|This issued to pass a Unique ID linked to the profile that is being transferred. For a guest profile, it
could be the customer loyalty number, for a company it could be the corporate ID. For a travel Agency it could be the IATA number.
|0
@Type
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo
/UniqueID
|The Type attribute refers to OpenTravel Alliance code type UIT and the choices recommended by HTNG should be:
1– Customer4– Company5–Travel Agency
| 1 | |@ID
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo
/UniqueID
|
The actual ID.
| 1 | |@IDContext
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo
/UniqueID
| Used to identify the source of the identifier (e.g., IATA, ABTA, Guest loyalty ID, CorprateId). | 0 | |Profile
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo
|Profile information. Used to pass the profile info for the guest, the Company or the Travel agency. For
the individual guest the code used in ProfileType is the OTA PRT code 1-
\[Customer], For a company it is PRT Code – 3 \[Corporation]. For a travel agency it is PRT code 4 – \[Travel agent]
| 1 | |@ProfileType
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile
|Code to specify a profile such as Customer, Booker, Tour Operator, Corporation, etc.
Supported type in RGBridge:
1: Customer
3: Corporate / Company profile
4: TravelAgent
18: Booker
|Customer
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile
| Profile details of a guest. Used to transmit the Customer details. Profile details of a guest. Optional for TravelAgent / Company profile. | 0..1 | |PersonName
/OTA\_HotelResNotifRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer
| Name of guest | 1 | |NamePrefix
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer/PersonName
| This field would be used to pass the guest’s name prefix | 0..1 | |GivenName
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer/PersonName
| Person name Part of guestname. This field would be used to pass the guest’s first name. | 1 | |SurName
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer/PersonName
| Surname part of guest name | 1 | |Telephone
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer
|
Guest phone number
| 0..1 | |@PhoneNumber
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer/Telephone
| The actual phone number | 1 | |@PhoneLocationType
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer/Telephone
|The PhoneLocationType attribute referstotheOTAPLT code list and indicates where the phone number is based – the values to be used are:
6 – Home
7 – Office
8 – Other (e.g. cell phone)
| 0..1 | |@PhoneTechType
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/ ProfileInfo/Profile/Customer/Telephone
|The PhoneTechType attribute refers to the OTA PTT code list and indicates which type of number is transmitted (phone vs fax). The 2 codes to be used are:
1 –Voice
3 –Fax
| 1 | |@CountryAccessCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer/Telephone
|Code assigned by telecommunications authorities for international country access
identifier.
| 0..1 | |@AreaCityCode
/OTA\_HotelResNotifRQ/HotelReservations/ HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer/Telephone
| Code assigned for telephones in a specific region, city, or area. | 0..1 | |@FormattedInd
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer/Telephone
|Formatted Ind is MANDATORY. If the partner can use Country and Area codes then it should be set to NO.
If country code and area code are passed then they should not appear again in the PhoneNumber field.
If the partner cannot use country and area code then entire number is passed in the PhoneNumber field and FormattedIndit should be set to YES if the number needs to be parsed as there is a separation of the different parts or set to NO to indicate that the PhoneNumber field contains the entire phone number without a specific format.
| 1 | |@ DefaultInd
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer/Telephone
| DefaultInd is optional and would indicate whether the phone number is the primary phone number for the profile | 0..1 | |/OTA\_HotelResNotifRQ/HotelReservations/ HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer
|
Guest Email
| 0..1 | |@EmailType
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer/Email
| The Email Type attribute uses the OTA code list EAT and indicates the type of email address provided (personal – code 1 vs business – code 2, in the case of the Guest details) and must be passed if more than one email address is passed. If only one email address is passed this is optional. | 1 | |@DefaultInd
/OTA\_HotelResNotifRQ/HotelReservations/ HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer/Email
| DefaultInd is optional and would indicate whether the email is the primary email for the profile | 0..1 | |Address
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer
| Address of the guest | 0..1 | |@Type
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer/Address
|The Type attribute uses the OTA code list CLT and indicates the type of address provided
1 - Home
2 - Business
3 - Other
| 0..1 | |AddressLine
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer/Address
| Will contain 1 to 3 Address lines. Will contain at least 1 line | 1 | |CityName
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer/Address
| City Name | 0..1 | |StateProv
/OTA\_HotelResNotifRQ/HotelReservations/ HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer/Address
|
State Name
| 0..1 | |@ StateCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer/Address/StateProv
|
State Code
| 0..1 | |PostalCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer/Address
|
Postal Code
| 0..1 | |CountryName
/OTA\_HotelResNotifRQ/HotelReservations/ HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer/Address
|
Country name
| 0..1 | |@ Code
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/Customer/Address/CountryName
|
ISO Country code
| 0..1 | |CompanyInfo
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile
| Company information related to the profile. Detailed information about a company or a travel agent. |0..1
| |
CompanyName
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/CompanyInfo
|
Detailed name information for the company. Identifies a company by name.
| 0..1 | |TelephoneInfo
/OTA\_HotelResNotifRQ/HotelReservations/ HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/CompanyInfo
|
Company phone number
| 0..1 | |@PhoneNumber
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/CompanyInfo/TelephoneInfo
|
The actual phone number
| 0..1 | |@PhoneLocationType
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/CompanyInfo/TelephoneInfo
|The PhoneLocationType attribute
refers to the OTA PLT code list and indicates where the phone number is based –the values to be used are:
6 – Home
7 – Office
8 – Other (e.g. cell phone)
| 0..1 | |@PhoneTechType
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/CompanyInfo/TelephoneInfo
|The PhoneTechType attribute refers to the OTA PTT code list and indicates which type of number is transmitted (phone vs fax). The 2 codes to be used are:
1 –Voice
3 –Fax
| 0..1 | |@CountryAccessCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/CompanyInfo/TelephoneInfo
| Code assigned by telecommunications authorities for international country access identifier | 0..1 | |@AreaCityCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/CompanyInfo/TelephoneInfo
| Code assigned for telephones in a specific region, city, or area | 0..1 | |@FormattedInd
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/CompanyInfo/TelephoneInfo
|FormattedInd is MANDATORY. If the partner can use Country and Area codes then it should be set to NO.
If country code and area code are passed then they should not appear again in the PhoneNumber field.
If the partner cannot use country and area code then entire number is passed in the PhoneNumber field and FormattedIndit should be set to YES if the number needs to be parsed as there is a separation of the different parts or set to NO to indicate that the PhoneNumber field contains the entire phone number without a specific format.
| 1 | |@ DefaultInd
/OTA\_HotelResNotifRQ/HotelReservations/ HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/CompanyInfo/TelephoneInfo
| DefaultInd is optional and would indicate whether the phone number is the primary phone number for the profile. | 0..1 | |/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/CompanyInfo
| This element is used to pass the Company or Travel Agency’s email | 0..1 | |AddressInfo
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/CompanyInfo
| Address of the guest | 0..1 | |AddressLine
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/CompanyInfo/AddressInfo
|Will contain 1 to 3 Address lines.
Will contain at least 1 line
| 1 | |CityName
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/CompanyInfo/AddressInfo
|
City Name
| 0..1 | |StateProv
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/CompanyInfo/AddressInfo
|
State Name
| 0..1 | |@ StateCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/CompanyInfo/AddressInfo/StateProv
|
State Code
| 0..1 | |PostalCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/CompanyInfo/AddressInfo
|
Postal Code
| 0..1 | |CountryName
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/CompanyInfo/AddressInfo
|
Country name
| 0..1 | |@ Code
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGuests/ResGuest/Profiles/
ProfileInfo/Profile/CompanyInfo/AddressInfo/CountryName
|
ISO Country code
| 0..1 | |ResGlobalInfo
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation
| ResGlobalInfo is a container for various information elements that affect the Reservation as a whole. These include global comments, counts, reservation IDs, loyalty programs, and payment methods. | 1 | |HotelReservationIDs
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo
| Contains reservation ID elements. For new reservations, this will only contain OTA confirmation number. For modifications and cancellations, original PMS confirmation numbers will be included. | 1 | |HotelReservationID
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo/HotelReservationIDs
|The HotelReservationID element can be repeated multiple types to
transfer:
• The MASTER reservation number in case of multi room bookings
• The OTA and PMSconfirmation numbers assigned to this booking
| 2..3 | |@ResID\_Type
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo/HotelReservationIDs
/HotelReservationID
|ResID\_Type is assigned values from the UIT code list.
16 – “Master” reservation number (when multiple (split) reservations need to be grouped together in case of multi room bookings)
14 – for CRS confirmation number
13 - for the IDS confirmation number
If the partner is working on split mode, Type=16 represents per leg of the Room reservation booked.
@ResID\_Value
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo/HotelReservationIDs
/HotelReservationID
| ResID\_Value would be the confirmation number of the reservation identified by the ResID\_Type. | 1 | |Guarantee
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo/
|The guarantee information associated to the Room Stay.
If do not have any CC details, it may be optional or have blank CC details included.
| 0..1 | |@GuaranteeType
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo/Guarantee
|This is the attribute that indicates what guarantee is provided with the reservation.
The enumerated values can be:
• “None"
• "CC / DC / Voucher"
| 1 | |@GuaranteeCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo/Guarantee
|This is the guarantee code. Can be either of the options below:
CreditCard
NOT GUARANTEED
| 1 | |GuaranteesAccepted
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo/Guarantee
| A collection of guarantee elements | 0..1 | |GuaranteeAccepted
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo/Guarantee/
GuaranteesAccepted
| Guarantee detail | 1 | |PaymentCard
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo/Guarantee/
GuaranteesAccepted/GuaranteeAccepted/
PaymentCard
| Identification about a specific credit card. Mandatory if @GuaranteeCode=CreditCard | 1 | |@CardType
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo/Guarantee/
GuaranteesAccepted/GuaranteeAccepted/
PaymentCard
|This is the code of the card used as guarantee for the booking. CardTypeuses an OTAlist. The only item of the CDT list to be used is number 1 – Credit to indicate we are passing a credit card. Mandatory if @GuaranteeCode=CreditCard
1=Credit Card
| 1 | |@CardCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo/Guarantee/
GuaranteesAccepted/GuaranteeAccepted/
PaymentCard
|The Card code is the 2 letter code indicative of the card (VI, MC, AX etc)
Mandatory if @GuaranteeCode=CreditCard
| 1 | |@CardNumber
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo/Guarantee/
GuaranteesAccepted/GuaranteeAccepted/
PaymentCard
|Mandatory if credit card guarantee info is passed. This is actual number of the credit card used as guarantee.
Mandatory if @GuaranteeCode=CreditCard
| 1 | |@ExpireDate
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo/Guarantee/
GuaranteesAccepted/GuaranteeAccepted/
PaymentCard
|Mandatory if credit card guarantee info is passed. This is expiry date of the credit card used as guarantee.
Format MMYY, e.g.
ExpireDate="1010"
Mandatory if @GuaranteeCode=CreditCard
| 1 | |
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo/Guarantee/
GuaranteesAccepted/GuaranteeAccepted/
PaymentCard
| Optional. This is the CVV (Card Verification Value) or CSN (Card Security No.) of the credit card used. | 0..1 | |CardHolderName
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo/Guarantee/
GuaranteesAccepted/GuaranteeAccepted/
PaymentCard
|Mandatory if @GuaranteeCode=CreditCard.
This is the name of the card holder. If the system transmitting the info does not hold the cc holder name, will be set by default to NOT AVAILABLE
| 1 | |GuaranteeDescription
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo/Guarantee/
| Optional. This can be used to pass the details of the guarantee if the guarantee used is not cc or deposit. | 0..1 | |@Name
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo/Guarantee/
GuaranteeDescription
| Used in conjunction with Text element below. Name could be used to indicate Voucher and the Text could be used to indicate the voucher number for instance. | 0..1 | |Text
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo/Guarantee/
GuaranteeDescription
| The text of the guarantee description | 0..1 | |TimeSpan
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo/
| The Time Span which covers the Room Stay. Used to specify a time window range by either specifying an earliest and latest date for the start date and end date or by giving a date with a time period that can be applied before and/or after the start date. | 1 | |@Start
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo/TimeSpan
|
Check-in date for this room stay
| 1 | |@End
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/ResGlobalInfo/TimeSpan
|
Check-out date for this room stay
| 1 | |Total
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay
| The total amount charged for the whole Stay | 1 | |@CurrencyCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/Total
|
Indicates the currency of the total
| 1 | |@AmountBeforeTax
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/Total
| Total amount excluding tax. Either AmountBeforeTax or AmountAfterTax must be present. | 0..1 | |@AmountAfterTax
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/RoomStays/RoomStay/Total
|Total amount including tax.
Either AmountBeforeTax or AmountAfterTax must be present
| 0..1 | |Services
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation
| 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. | 0..1 | |Service
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/Services
| A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges. | 1 | |
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/Services/Service
| This is a reference placeholder, used as an index for this service in this reservation. It is used by the RoomStay objects to indicate which services are associated with that room stay. | 0..1 | |@Inclusive
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/Services/Service
|Whetherthepricefor thisservice is included in the room rate.
Values: False (or No), and True (or Yes).
| 0..1 | |
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/Services/Service
| The number of tickets, rounds of golf, etc. Also serves as the number of persons when pricing class is per person or per person per night. | 0..1 | |@RatePlanCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/Services/Service
| The representation of the rate plan under which this service was booked. | 0..1 | |@ServiceInventoryCode
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/Services/Service
|
The representation of the specific service being reserved.
| 0..1 | |@ServicePricingType
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/Services/Service
|An enumerated type that defines how a service is priced.
Values:
Per stay
Per person
Per night
Per person per night
Per use
| 0..1 | |Price
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/Services/Service
|
The selling price of this service
| 0..1 | |ServiceDetails
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/Services/Service
| Details on the Service including Guest Counts, Time Span of this Service, pointers to Res Guests. | 0..1 | |GuestCounts
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/Services/Service
| Guest type-wise count of guests for this service. Similar to GuestCounts under RoomStay. Please see above. | 0..1 | |ResGuestRPHs
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/Services/Service
| A collection of ResGuestRPH objects. A collection of unsigned integers serving as reference placeholders, and used as an index identifying which guests avail this service. Similar to ResGuestRPHs under RoomStay. Please see above. | 0..1 | |TimeSpan
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/Services/Service
|
Similar to TimeSpan under RoomStay. Please see above.
| 0..1 | |Total
/OTA\_HotelResNotifRQ/HotelReservations/
HotelReservation/Services/Service
|
Similar to Total under RoomStay. Please see above.
| 0..1 | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://developer.rategain.com/our-products/channel-manager/rg-bridge-supply-push/interface-specifications-reservation-notification-service/operations/reservation-notification/xml-usage-specification.md?ask=