Push API - SOAP

1 Introduction
2 SOAP Faults

Introduction

All request messages exchanged between the Windsurfer and partners must be authenticated using the WS-Security mechanism of the SOAP standards. This should conform to the specification of HTNG Web Services Framework 2.1

The SOAP header elements are based on HTNG format and the elements are described below:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:a="
http://schemas.xmlsoap.org/ws/2004/08/addressing">
	<s:Header>
		<a:Action>http://cgbridge.rategain.com/2011A/ARIService/Availability</a:Action>
		<a:To>endpoint URL</a:To>
		<o:Security xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
			<o:UsernameToken>
				<o:Username>userName</o:Username>
				<o:Password>password</o:Password>
			</o:UsernameToken>
		</o:Security>
	</s:Header>
	<s:Body>
		
	</s:Body>
</s:Envelope>

Element or @Attribute	Description	Occurrences

Element or @Attribute	Description	Occurrences
SoapEnvelope/SoapHeader/MessageID	Alphanumeric sequence of characters to uniquely identify the message	0..1
SoapEnvelope/SoapHeader/ReplyTo	Optional. Always set to: http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous	0..1
SoapEnvelope/SoapHeader/To	URI of the Web Service	1
SoapEnvelope/SoapHeader/Action	Action for the request. Always set to:	1
SoapEnvelope/SoapHeader/Security	This elements holds all the information related to security	1
SoapEnvelope/SoapHeader/Security/UsernameToken	Contains the service security credentials.	1
SoapEnvelope/SoapHeader/Security/UsernameToken/Username	Contains the Username credentials.	1
SoapEnvelope/SoapHeader/Security/UsernameToken/Password	Contains the Password credentials.	1

SOAP Faults

SOAP Faults are provided as a mechanism for handling error conditions. A SOAP fault will be generated and returned if the message does not meet the web service specifications. It is also possible to receive this response occasionally, due to software malfunction on the Windsurfer side. The external channel system must be prepared to receive and process SOAP faults.