Reservation API
- Luke Bayly (Unlicensed)
- Paul Collado Orta
- Rod De Sebastian Martin
Intended Audience
This document is intended for developers and assumes the reader has working knowledge of XML and SOAP.
Introduction
PMS partners (Reservation Uploader) can push reservations, modifications and cancellations to SiteMinder Exchange (SMX) using an OTA_HotelResNotifRQ.
The request is to be sent as a SOAP message as per the SMX SOAP Envelope sample provided here.
Communications
Communications between both systems is via the exchange of SOAP messages over secure HTTP (HTTPS). Operations are synchronous request/response pairs. A message is considered to be atomic and is either processed entirely or not at all by the Web Service.
Supported Functions
OTA_HotelResNotifRQ - Used to push reservation notifications to SMX via pmsXchange.
OTA
The SMX For PMS API is based on the Open Travel Alliance (OTA) specifications for 2017A. Although this document attempts to be technically comprehensive it is expected that the connecting system’s developers be somewhat familiar with the OTA specifications found here.
Process Flow
When a reservation is created, modified or cancelled in the partner PMS application (Reservation Uploader), the PMS partner will need to push these reservation messages to SiteMinder's pmsXchange reservation web service endpoint. pmsXchange will direct these reservation to pre-allocated partner PMS and hotel specific storage areas, these reservations will then be available for delivery to Application partners via the SMX platform. The Application partners can then use these reservations to offer value added solution.
Scenarios for Reservation delivery from partner PMS applications:
If the
OTA_HotelResNotifRQmessage is delivered successfully by the partner PMS application to SMX, the pmsXchange web service endpoint will respond with an OTA_HotelResNotifRS success message, which includes the Hotel System Confirmation ID.If the
OTA_HotelResNotifRQmessage delivery flags an error in SMX, the pmsXchange web service endpoint will respond with an OTA_HotelResNotifRS error message, which includes an error string. The reservation will need to retained in the partner PMS application retry cycle and resent once the error is resolved. The message resend process may need to be done manually upon expiry of retry cycle time period.If the
OTA_HotelResNotifRQmessage is unable to be delivered by partner PMS application due to a network outage or similar connectivity issues, the reservation will need to retained in the partner PMS application retry cycle and resent once the error is resolved. The message resend process may need to be done manually upon expiry of retry cycle time period.
Security
Encryption is provided by the transport layer via HTTPS. Each message contains a WS-Security (WSSE) UsernameToken SOAP header for authentication/authorisation purposes. Each connecting SMX Partner Application will need to provide a webservice endpoint to receive the reservation notifications.
