| Table of Contents |
|---|
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
IMPORTANT NOTE: It should be noted that no PCI sensitive data should be communicated within the OTA_HotelResNotifRQ. We ask that you implement a regex check across all elements and attributes to check for Credit Card numbers and strip them out before sending to SMX. There are various resources available that detail how to do this.
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 booked.
- A RoomStay represents a stay in one room 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
| Info |
|---|
Elements and attributes marked with Number=1 or more will always be sent. 0 means that the element or attribute is optional, while a second numeric value or 'n' indicates the element or attribute can repeat (where n = no limit)" |
...
OTA_HotelResNotifRQ
...
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'
...
Indicates the current status of the reservation.
Valid values are dependant on the roles:
-Reserved
-Waitlisted
-Cancelled
-No-show
-In-house
-Checked-Out
...
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'
...
This indicates the last date and time when the reservation was last modified.
Mandatory if a message relating to this reservation has already been uploaded.
Format like yyyy-MM-dd'T'HH:mm:ssZZ i.e '2012-03-09T20:05:52+08:00'
...
Identifies the company that is associated with the booking channel.
...
Identifies a company by the company code.
...
@ID
...
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
15: Promotion information
...
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
15: Promotion information
...
Code that identifies an inventory block.
...
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.
Each 'Rate' element should only contain a single night. If the reservation is for mulitple nights, then multiple 'Rate' elements should be present.
...
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.
...
Tax percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value).
...
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.
...
Tax percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value).
...
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.
...
An enumerated type defining the guarantee to be applied to this reservation.
Value:
CC/DC/Voucher
Deposit
DepositRequired
GuaranteeRequired
None
PrePay
Profile
...
0..1
...
Guarantee Detail.
One of PaymentCard, Voucher, DirectBill elements must be included within GuranteeAccepted.
...
This is used to indicate either a charge, reserve (deposit) or refund.
| Value | Description |
|---|---|
| charge | This indicates that an actual payment has been made. |
| refund | This indicates that the payment amount of this PaymentDetail element is for a refund. |
| reserve | This indicates that a hold for the indicated amount has been placed on a credit card or that a cash amount has been taken from the customer to guarantee final payment. |
...
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.
...
Issuer code. See OTA Payment Card Provider Codes
...
This is used to indicate either a charge, reserve (deposit) or refund.
| Value | Description |
|---|---|
| charge | This indicates that an actual payment has been made. |
| refund | This indicates that the payment amount of this PaymentDetail element is for a refund. |
| reserve | This indicates that a hold for the indicated amount has been placed on a credit card or that a cash amount has been taken from the customer to guarantee final payment. |
...
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.
...
...
The address to which a deposit may be sent.
...
Code identifying the fee (e.g.,agency fee, municipality fee). Refer to OpenTravel Code List Fee Tax Type (FTT).
...
Fee percentage
...
Defines the age of a guest.
...
The starting value of the time span.
...
Description of the service
...
The individual billing code that applies to a set of instructions that are routed to a designated folio.
...
Identifies the account number where the charges will be routed.
...
The starting value of the time span.
...
The ending value of the time span.
...
The authorization code associated with the billing code.
...
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests
...
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.
...
The age of the guest.
...
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles
...
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.
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
The Time Span which covers the Reservation
...
An enumerated type defining the guarantee to be applied to this reservation.
Value:
CC/DC/Voucher
Deposit
DepositRequired
GuaranteeRequired
None
PrePay
Profile
...
0..1
...
This is used to indicate either a charge, reserve (deposit) or refund.
Value | Description |
|---|---|
| charge | This indicates that an actual payment has been made. |
| refund | This indicates that the payment amount of this PaymentDetail element is for a refund. |
| reserve | This indicates that a hold for the indicated amount has been placed on a credit card or that a cash amount has been taken from the customer to guarantee final payment. |
...
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.
...
Issuer code. See OTA Payment Card Provider Codes
...
This is used to indicate either a charge, reserve (deposit) or refund.
Value | Description |
|---|---|
| charge | This indicates that an actual payment has been made. |
| refund | This indicates that the payment amount of this PaymentDetail element is for a refund. |
| reserve | This indicates that a hold for the indicated amount has been placed on a credit card or that a cash amount has been taken from the customer to guarantee final payment. |
...
Specific payment card information. Details of a debit or credit card.
...
...
The address to which a deposit may be sent.
...
...
...
Defines the type of Reservation ID (e.g. reservation number, cancellation number). Refer to OpenTravel Code List Unique ID Type (UIT).
22 - ERSP (Such as SiteMinder)
...
A unique identifier to indicate the source system which generated the ResID_Value.
...
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.
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
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
| Info |
|---|
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. |
...
OTA_HotelResNotifRS Sample
| Code Block | ||||
|---|---|---|---|---|
| ||||
<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> |
...
| language | xml |
|---|---|
| title | OTA_HotelResNotifRS - Failure |
...
Introduction
SMX uses the Inventory API from pmsXchange to receive availability, rates and restrictions. All PMSs certified to push ARI to pmsXchange are able to become a Publisher for SMX.
Supported Functions
OTA_HotelAvailNotifRQ - Used to update availability, stop sell, minimum stay, maximum stay, closed to arrival and closed to departure.
OTA_HotelRateAmountNotifRQ - Used to update rates.
Become a ARI Publisher for SMX
To become a ARI Publisher for SMX contact your local SiteMinder Partnership representative or send an email with your request to ecosystem.team@siteminder.com.