- Contents
SOAP API Developer's Guide
SOAP Get Body Element
Retrieves the first body element that matches the given base name and namespace. If no namespace is specified, the first element matching ‘Base Name' is returned. Returns the first element in the body if neither a name nor namespace is given.
Exit Paths: Success, Not Found, 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. If no name given, the first entry in the body in ‘Namespace' is returned. This corresponds to the element of the method for RPC requests. |
Namespace |
IN |
String |
Optional. Namespace of the element to return |
Retrieve Value |
IN |
Boolean |
Checkbox: False Default. Do not retrieve value True Return node value |
Body Element |
OUT |
Node |
Child element of the <SOAP-ENV:Body> element that has the given base name and namespace. NULL node if the element is not in the body. |
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 body element (if ‘Retrieve Value' = True) |