- Contents
SOAP API Developer's Guide
SOAP Add Body Element
Adds an entry to the body of the SOAP envelope. Use the XML tools on the returned ‘Element' node to add rich contents to the element (not just a string).
Tip—If the ‘Name' argument has no namespace prefix and a ‘Namespace' different than "" (default namespace) is specified, a prefix will be synthesized, unless the local name starts with a ‘:' (which is illegal in XML, and thus signals to this tool not to add a synthesized namespace prefix). Adding a prefix can greatly reduce the size of the message if child elements are in no namespace, as otherwise each child element would get an xmlns="" attribute.
Exit Paths: Success, 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. |
Name |
IN |
String |
Fully qualified name of the element to create and add to the body. |
Namespace |
IN |
String |
Optional. Namespace URI of the element. If the parameter is omitted and the name has a namespace prefix, the tool will search in the parent elements for the namespace with the same prefix and make the element a member of this namespace. |
Encoding Style |
IN |
String |
Optional. Value of the ‘encodingStyle' attribute. Attribute is omitted if not specified or "NONE". Specify "STANDARD" for standard namespace ("http://schemas.xmlsoap.org/soap/encoding/"). |
Value |
IN |
String |
Optional. String value to set as content of the element. |
Replace Existing Body Element |
IN |
Boolean |
Checkbox: False Default. Add the element as last child of the body. True Replace first element in the body that has the same (local) name and namespace. If body contains multiple elements with the same name and namespace, the remaining ones are not modified. |
Delete All Existing Body Elements |
IN |
Boolean |
Checkbox: False Default. Append to the child list of the body. True Remove all existing elements from the body prior to adding the new element. |
Body Element |
OUT |
Node |
Node of the element that has just been added. |