SOAP Envelop

The SOAP Envelope encapsulates the entire message structure to be transmitted. It consists of two main components:

1. Header (Optional in SOAP, but required by RateGain)

2. Body (Mandatory)

RateGain Enterprise Connectivity uses a document-literal format for its web services.

SOAP Header

The SOAP Header contains metadata essential for message processing, including:

• Username and Password: Corresponding to an account created on the RateGain Enterprise Connectivity customer portal (https://portal.dhisco.com/portal/dt).

  • This account must be enabled for HCD content retrieval requests via web services.

• Action Code

• Transaction ID

While SOAP allows the Header element to be optional, RateGain Enterprise Connectivity mandates its inclusion in every request. Additionally, the following elements are required in the SOAP Header:

• ebXML:MessageHeader: Contains detailed information about the message.

• wsse:Security: Ensures message-level security.

Clients must reference the associated schema files for these elements to determine the required structure, elements, and attributes. Links to these schema files are available for integration guidance.

• http://www.oasis---open.org/committees/ebxml---msg/schema/msg---header---2_0.xsd

• http://schemas.xmlsoap.org/ws/2002/12/secext

The following table illustrates specific values that should be present in these elements.

Element	Attribute	/ O / C	Usage	Description
MessageHeader		R
	SOAP--- ENV:mustUnderstand	R	0 1	Indicates “true” or “false”
	version	R	2.0	Indicates the ebXML version
:From		R
PartyId		R		Supplier Name
To		R
PartyId		R	DHISCO
CPAId		R	ODDRetrieveInterface	The destination system
ConversationId		R	some value	This value can be used by the client to group a set of transactions into a “conversation”
Service		R	ODDRetrieveInterface	The destination service
	type	R	1.0	Defines the version of the eb:Service element
Action		R	RETRIEVE	Defines the action to be performed on the property
MessageData		R
MessageId		R		Unique Record ID
Timestamp		R
Security		R		Defines the wsse Security element
UsernameToken		R		Defines the UsernameToken element
	Username	R	user name	The client’s username will be defined by RG Enterprise Connectivity
	Password	R	password	The client’s password will be defined by RG Enterprise Connectivity