- Contents
SOAP API Developer's Guide
SOAP Get Header Elements
Returns iterator to a list of header elements filtered by the given arguments. Takes the ‘None' exit if envelope has no header or none of the header elements matched the filter criteria.
Exit Paths: Success, None, 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. Only include elements with this base name. |
Namespace |
IN |
String |
Optional. Only include elements in this namespace. |
Must Understand |
IN |
Boolean |
Optional: False Return header entries whose ‘mustUnderstand' attribute is "0" (or no attribute is specified) True Return header entries whose ‘mustUnderstand' attribute is "1". Default: Don't filter on ‘mustUnderstand' |
Actor URIs |
IN |
String |
Optional. Space separated list of actor URIs. Only elements whose actor attribute has one of these namespaces is returned. If not specified, don't filter on actor namespace. |
Header Elements |
OUT |
NodeIter |
Iterator to collection of header entries. Use the ‘XML Get Next Node' tool to iterate over collection. |
Count |
OUT |
Integer |
Number of items in the Header Entries collection |