Developer Guide

Supported Functions

  • OTA_HotelResNotifRQ - Used to PUSH reservation notifications to the SMX Partner Application.

  • OTA_HotelResNotifRS - Returned by the SMX Partner Application to confirm receipt or failure to process the reservation message.

Best Practices

Endpoint Requirements

Partners will need to provide SMX with a single web service endpoint to be used for message delivery. This endpoint must be global for all hotels using the connection, not for each unique hotel.

The endpoint must also accept incoming SMX requests with the header 'Accept', with the value application/xml.

Security

Encryption is provided by the transport layer via HTTPS. Each message contains a WS-Security (WSSE) UsernameToken SOAP header for authentication/authorization purposes. Each connecting SMX Partner Application will need to provide a webservice endpoint to receive the reservation notifications.

SSL/TLS

SMX supports TLSv1.2 and above.

SiteMinder does not support self-signed SSL certificates.

Content-Type

The ‘Content-Type’ for all SOAP XML messages must be application/xml; charset=utf-8.

Response Time Expectations

Endpoints should aim to respond within 1-2 seconds on average, with sub-1-second response times being ideal. The endpoint must respond with either a 'Success' or 'Error' message promptly.

Reservations Historical Data

SiteMinder Exchange is able to send a flush of historical reservation data for a selected time period: 3 months, 6 months, 1 year etc. The time period is only based on the creation date (booked-on date) of the reservation so the flush might include future reservations that were created (booked) in the selected time frame. All ResStatus values are expected to be sent in the flush.

Process Flow

When a reservation is created, modified or cancelled in the partner PMS application (Reservation Uploader/Data Publisher) and is pushed to SiteMinder’s SMX platform, SiteMinder will generate a notification for each reservation event and PUSH reservation notifications to subscribing SMX partner applications. Partner applications will need to provide a webservice endpoint to receive the reservation notifications. The subscribing SMX partner applications can then use these reservations to offer value-added solutions for the hospitality and travel industry.

Scenarios for Reservation delivery to subscribing SMX partner applications:

  • If the OTA_HotelResNotifRQ message is delivered successfully by SiteMinder to the SMX partner application, the partner application's web service endpoint will need to respond with an OTA_HotelResNotifRS success message.

  • If the OTA_HotelResNotifRQ message delivery flags an error in the SMX partner application, the partner application's web service endpoint will need to respond with an OTA_HotelResNotifRS error message, which should include an error string. The reservation will be retained in SMX's retry cycle and resent once the error is resolved. The message resend process may need to be done manually upon the expiry of the retry cycle period.

  • If the OTA_HotelResNotifRQ message is unable to be delivered to the SMX partner application due to a network outage or similar connectivity issues, the reservation will be retained in SMX's retry cycle and resent once the error is resolved. The message resend process may need to be done manually upon the expiry of the retry cycle period.

The SMX Partner Application should be able to accept all ResStatus values and respond with Success (200 OK status).

  • Reserved

  • Waitlisted

  • Cancelled

  • No-show

  • In-house

  • Checked-Out

  • Redacted

Last updated