- Contents
SOAP API Developer's Guide
SOAP Parse Request Payload
Parses the payload of the request into an XML document. If the ‘Validate SOAPAction' parameter is True, the tool checks the SOAPAction field of the request against the payload. The payload data is parsed every time this tool is invoked (i.e. it is not cached). The document is furthermore not read-only and thus may be modified as needed, for example to create the response. The payload envelope node will still be returned, even if the SOAP Action does not match.
Heuristic
This tool uses a heuristic to match the action code (legend: <NS> = namespace of the first body element; <MethodName> = Name of the element [method name]):
<NS>
<NS> [<AnyCharacter>] <MethodName>
<MethodName>
[<AnyCharacter>] <MethodName>
This will catch actions such as "uri:my-uri#MyMethod", "http://soap.inin.com/e-faq", "MyMethod" etc. An empty SOAPAction matches all methods.
Parameter |
Dir |
Type |
Remarks |
SOAP Request |
IN |
Handle |
Handle of the SOAP request |
Validate SOAPAction |
IN |
Boolean |
Checkbox: False Don't verify SOAPAction header field against payload. True Default. Check SOAPAction header field against method namespace and name. |
Action Validation Mask |
IN |
String |
Optional. Mask for validation of SOAP Action. |
Selection Namespaces |
IN |
String |
Optional. Space delimited list of namespace declarations
to be set as selection namespaces the XPath queries. If this argument
not specified, just "SOAP-ENV" is mapped to the envelope
namespace. The "SOAP-ENV" prefix will be used irrespective of the actual prefix in the payload. A declaration mapping "SOAP-ENV" to the envelope namespace will always be added to the declarations, unless SOAP-ENV is already declared in the argument. |
Preserve Whitespace |
IN |
Boolean |
Checkbox: False Default. Nonessential whitespace is ignored when parsing the payload. True Preserve nonessential white space |
Validate On Parse |
IN |
Boolean |
Checkbox: False Default. Only verifies for well-formedness. True Validates against the schema during parse. |
Resolve Externals |
IN |
Boolean |
Checkbox: False Default. Do not resolve resolvable namespaces. True Resolve resolvable externals (namespaces, DTDs, entity references etc.) at parse time. |
Payload |
OUT |
Node |
XML document with Envelope as document element. If there is an error, the document may be empty (but not NULL), and the ‘XML Get Error Info' tool can be used to retrieve information about what failed). |
Exit Paths
- Success
-
Payload successfully parsed. SOAP Action matches.
- Empty Payload
-
SOAP Payload is empty (XML document has no document element).
- Wrong Action
-
SOAP Action validation enabled and action doesn't match.
- Parse Error
-
A parse error occurred parsing the payload. Use ‘XML Get Error Info'.
- Failure
-
Some other failure. Use ‘XML Get Error Info'.