Skip to end of banner
Go to start of banner

Integration Requirements - READ ME FIRST

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 21 Next »

Integration Requirements Guidelines

In accordance with the API Services Terms of Use Agreement signed by the PMS partner before development has commenced, these guidelines are in place to ensure efficient and proper use of the SMX for PMS API.

The following Integration Requirements must be adhered to by all PMS' that have or wish to have an interface to SiteMinder Exchange for Publishers.

Failure to follow these guidelines could jeopardise the PMS interface and, if no action is taken by the PMS provider to rectify non-compliance within 3 months from notification, SiteMinder reserves the right to disable the interface till such corrections have taken place.

Please note, however, that if the non-compliance of the PMS puts the performance to the whole SiteMinder production environment at risk, SiteMinder reserves the right to disable the interface immediately.


EchoTokens

EchoTokens are essential for all requests made over SiteMinder Exchange as per the following link - EchoToken, Timestamp and POS.

NOTE: Please ensure that you implement EchoTokens that are as 'unique' as possible to ensure that log trawling for troubleshooting purposes on either side is quick and efficient. Implementing GUIDs are recommended and more information about GUID can be found - http://en.wikipedia.org/wiki/Globally_unique_identifier.

File Upload Size

Uploaded messages must not be larger than 2MB (uncompressed)

Error Handling / Hotelier Error Awareness

It is expected that your PMS has a robust error handling process whereby errors can be queued and resent. 

GDPR - General Data Protection Regulation

We require you to implement the elements @ShareAllMarketInd and @ShareAllOptOutInd in the guest information you send under ResGuest Profiles and ResGlobalInfo Profiles. The SMX Applications can use the above fields to identify guests who do not wish to receive any communication and also take necessary guest data anonymisation action on their side.

Reservation Upload - Minimum Suggested Content

The minimum suggested content reflects the minimum amount of data that needs to be provided in order to meet the critical data required by all types of applications.

ElementAttribute
Description
OTA_HotelResNotifRQ
Mandatory

@VersionMandatory

@EchoTokenMandatory

@TimeStampMandatory
OTA_HotelResNotifRQ / HotelReservations / HotelReservation
Suggested

@ResStatusMandatory

@CreateDateTimeMandatory

@LastModifyDateTimeMandatory if a message relating to this reservation has already been uploaded.
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / POS / Source / RequestorID
Mandatory

@IDMandatory
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / POS / Source / BookingChannel
Suggested

@TypeSuggested

@PrimarySuggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / POS / Source / CompanyName
Suggested

@CodeSuggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / UniqueID
Mandatory

@IDMandatory
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays
Mandatory
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay
Suggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomTypes / RoomType
Suggested

@RoomTypeSuggested

@RoomTypeCodeSuggested

@RoomIDSuggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RatePlans / RatePlan 
Suggested

@RatePlanCodeSuggested

@EffectiveDateSuggested

@ExpireDateSuggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate
Suggested

@RoomIDSuggested

@RoomTypeCodeSuggested

@RatePlanCodeSuggested

@EffectiveDateSuggested

@ExpireDateSuggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / Rates / Rate
Suggested

@EffectiveDateSuggested

@ExpireDateSuggested

@UnitMultiplierSuggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / RoomRates / RoomRate / Rates / Rate / Total
Suggested

@AmountBeforeTaxSuggested

@AmountAfterTaxSuggested

@CurrencyCodeSuggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / GuestCounts / GuestCount
Suggested

@AgeQualifyingCodeSuggested

@CountSuggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / TimeSpan
Mandatory

@StartMandatory

@EndMandatory
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / Total
Suggested

@AmountBeforeTaxSuggested

@AmountAfterTaxSuggested

@CurrencyCodeSuggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / RoomStays / RoomStay / ResGuestRPHs / ResGuestRPH
Suggested

@RPHSuggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest
Suggested

@ResGuestRPHSuggested

@AgeQualifyingCodeSuggested

@PrimaryIndicatorSuggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile
Suggested

@ShareAllOptOutIndSuggestedMandatory for GDPR compliance

@ShareAllMarketIndSuggestedMandatory for GDPR compliance
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / PersonName
Suggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / PersonName / GivenName
Suggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / PersonName / Surname
Suggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGuests / ResGuest / Profiles / ProfileInfo / Profile / Customer / Email
Suggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo
Suggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / GuestCounts / GuestCount
Mandatory

@AgeQualifyingCodeSuggested

@CountSuggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / TimeSpan
Mandatory

@StartMandatory

@EndMandatory
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Total
Mandatory

@AmountBeforeTaxMandatory (May be AmountAfterTax)

@AmountAfterTaxMandatory (May be AmountBeforeTax)

@CurrencyCodeSuggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / HotelReservationIDs / HotelReservationID
Suggested

@ResID_ValueSuggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile
Suggested

@ShareAllOptOutIndSuggestedMandatory for GDPR compliance

@ShareAllMarketIndSuggestedMandatory for GDPR compliance
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / Customer / PersonName
Suggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / Customer / PersonName / GivenName
Suggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / Customer / PersonName / Surname
Suggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / Profiles / ProfileInfo / Profile / Customer / Email
Suggested
OTA_HotelResNotifRQ / HotelReservations / HotelReservation / ResGlobalInfo / BasicPropertyInfo
Mandatory

@HotelCodeMandatory







  • No labels