All messages exchanged with Channel Manager API are soap messages. They are divided in two parts, the header which include a SOAP Security header for authentication purposes and the body which contains the OTA message. See the following example as a complete SOAP message (this one shows an OTA_ReadRQ message payload)

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
 
  <soap:Header>
    <wsse:Security soap:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
      <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:Header>
 
  <soap:Body>
 
    <!-- OTA Message --> 
 
  </soap:Body>
</soap:Envelope>

Soap Security Header

The Security Header contains the authentication information. In order to be authentified the /wsse:UsernameToken/wsse:Username and /wsse:UsernameToken/wsse:Password elements are mandatory. 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", indicating a plain text password. Due to the HTTP encrypted communication plain text is acceptable.

Each connecting Channel Manager API partner will be allocated a USERNAME and PASSWORD for use with this header.

Soap Faults

Generally OTA messages transmit "business logic" failures in the <Errors> element structure. However a soap fault can be returned in case of an unexpected error caused by for example a soap message where the xml cannot be parsed. The SOAP Fault will identify the party at fault (CLIENT/SERVER).

SOAP Fault - Invalid XML

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <SOAP-ENV:Fault>
      <faultcode>
        SOAP-ENV:Client
      </faultcode>
      <faultstring xml:lang="en" xmlns:xml="http://www.w3.org/XML/1998/namespace">
        Authentication failed - invalid username
      </faultstring>
    </SOAP-ENV:Fault>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Ulyses Cloud Channel Manager API

SOAP Message Structure

Soap Security Header

Soap Faults

Related content