Help us improve the Developer Guide! Share your feedback using the “Was this helpful?” option on the right of each page.

Message Structure

Learn how SOAP messages must be structured when using the SiteConnect API, including formatting, headers, and authentication requirements.

Soap Message Structure

All messages (Requests/Responses) exchanged between SiteMinder and the booking channel must:

  • Adhere to the SOAP message format.

  • Encapsulate the OTA message within the SOAP Body.

  • Requests must include a SOAP Security Header for authentication purposes.

  • Responses must be returned in a SOAP envelope. However, the SOAP Header should be empty.

Version

SiteConnect is using SOAP 1.1

Name
Value

Content-Type

text/xml; charset=utf-8

Authorization

Basic <credentials>

Security Header

The Security Header structure conveys authentication information.

<wsse:Security soap:mustUnderstand="1"
	xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
	xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<wsse:UsernameToken>
		<wsse:Username>USERNAME</wsse:Username>
		<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">SECRET</wsse:Password>
	</wsse:UsernameToken>
</wsse:Security>

The only acceptable value for the Password @Type attribute is http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText. Plain text passwords are acceptable as all communication is done over encrypted HTTP (HTTPS).

Credentials

Partners must provide SiteMinder with a single username and password to be used for authentication. These credentials must be global for all hotels using the connection.

Examples

<SOAP-ENV:Envelope
	xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
	<SOAP-ENV:Header
		xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
		<wsse:Security
			xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
			xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" soap:mustUnderstand="1">
			<wsse:UsernameToken>
				<wsse:Username>USERNAME</wsse:Username>
				<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">SECRET</wsse:Password>
			</wsse:UsernameToken>
		</wsse:Security>
	</SOAP-ENV:Header>
	<SOAP-ENV:Body
		xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
		<OTA_HotelAvailRQ ... >
			<!-- ... other elements and attributes have been omitted for brevity ... -->
		</OTA_HotelAvailRQ>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Last updated

Was this helpful?