SOAP Web Services: Input and Output XML

For each SOAP web service an input/output handler can be defined within the web service configuration (nodes <InputHandler/> and<OutputHandler/>). They control which XML data structure is expected, respectively created during the transfer to webservices.

Mode SOAP-Envelope: Input Handler

If the mode SOAP-Envelope has been defined as input handler (XML storage format: <InputHandler type="SOAP-Envelope"/>), the complete XML of the SOAP request will be passed, including header information and content of the body.

XML

 <?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <GetEntry>
         <id>?</id>
      </GetEntry>
   </soapenv:Body>
</soapenv:Envelope>

Mode SOAP-Envelope-Validated: Input Handler

If the mode SOAP-Envelope-Validated has been defined as input handler, the complete XML document of the SOAP request will be handed over, including header information and content of the body. Moreover, the input is validated against the WSDL definition and its XSD schemas.

If validation errors occur, the result document will contain a SOAP Fault element (e.g. within an element <SOAP-ENV:Fault>) with the error messages.

This mode requires the service configuration field WSDL URL to contain a valid WSDL URL, and the WSDL has been made available via Load Configuration from WSDL. See also Providing SOAP Web Services with External WSDL Definition.

Mode SOAP-Envelope: Output Handler

Similar to the input handler, if the mode SOAP-Envelope has been defined as output handler (XML storage format: <OutputHandler type="SOAP-Envelope"/>), the Technical Process is responsible for the complete SOAP document's creation and thus for the creation of the SOAP-Envelope, SOAP-Header and SOAP-Body.

XML

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
     <SomeHeader />
  </soap:Header>
  <soap:Body>
    <SomeData />
  </soap:Body>
</soap:Envelope/>

Mode SOAP-Content: Input Handler

If the mode SOAP-Content has been defined as input handler (XML storage format: <InputHandler type="SOAP-Envelope"/>), the first node of the Body will be passed within the SOAP request.

EXample: SOAP request

XML

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
     <SomeHeader />
  </soap:Header>
  <soap:Body>
    <GetEntry>
   		<id>101</id>
	</GetEntry>
  </soap:Body>
</soap:Envelope/>

Example: Process input

XML

<?xml version="1.0" encoding="UTF-8"?>
<GetEntry>
   <id>101</id>
</GetEntry>

Mode SOAP-Content-Validated: Input Handler

If the mode SOAP-Content-Validated has been defined as input handler, the first node of the Body will be passed within the SOAP request. Moreover, the input is validated against the WSDL definition and its XSD schemas.

If validation errors occur, the result document will contain a SOAP Fault element (e.g. within an element <SOAP-ENV:Fault>) with the error messages.

This mode requires the service configuration field WSDL URL to contain a valid WSDL URL, and the WSDL has been made available via Load Configuration from WSDL. See also Providing SOAP Web Services with External WSDL Definition.

Mode SOAP-Content: Output Handler

Similar to the input handler, if the mode SOAP-Content has been defined as output handler (XML storage format: <OutputHandler type="SOAP-Content"/>), the result of the Technical Process is taken as content of the SOAP body for the SOAP response.

XML

<?xml version="1.0" encoding="UTF-8"?>
<GetEntryResponse>
    <Data>
        <customer>
            <customerid>101</customerid>
            <companyname>SoftProject GmbH</companyname>
            <address>Am Erlengraben 3</address>
            <city>Ettlingen</city>
            <postalcode>76275</postalcode>
            <country>Germany</country>
            <phone>+49 (0)7243 | 561 75-0</phone>
        </customer>
    </Data>
</GetEntryResponse>

Transformation of the Process Result into the Response Body

If the process result is <SomeData/> and it is a SOAP 1.1 request, the following response will be sent:

XML

<SOAP11:Envelope xmlns:SOAP11="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP11:Body>
    <SomeData/>
  </SOAP11:Body>
</SOAP11:Envelope/>

If the process result is <SomeData/> and it is a SOAP 1.2 request, the following response will be sent:

XML

<SOAP12:Envelope xmlns:SOAP12="http://www.w3.org/2003/05/soap-envelope">
  <SOAP12:Body>
    <SomeData/>
  </SOAP12:Body>
</SOAP12:Envelope/>