- Contents
SOAP API Developer's Guide
SOAP Get Header Element
Retrieves the first header element that matches the given base name and namespace. Returns the first element in the header if neither a name nor namespace is given. Takes ‘Not Found' exit if the envelope doesn't have a header or the element can't be found.
Exit Paths: Success, Not Found, No Header, Failure
Parameter |
Dir |
Type |
Remarks |
Envelope |
IN |
Node |
Envelope node of the SOAP payload. Can be a document node whose document element is <SOAP-ENV:Envelope> or the node is the element itself. |
Base Name |
IN |
String |
Optional. Base Name of the element to return |
Namespace |
IN |
String |
Optional. Namespace of the entry to return |
Retrieve Value |
IN |
Boolean |
Checkbox: False Do not retrieve value True Default. Return node value |
Header Element |
OUT |
Node |
Child element of the <SOAP-ENV:Header> element that has the given base name and namespace. NULL node if the envelope contains no header or the element is not in the header. |
Element Base Name |
OUT |
String |
Base name of the returned element |
Element Namespace |
OUT |
String |
Namespace URI of the returned element |
Value |
OUT |
String |
Value of the element (if ‘Retrieve Value' = True) |