- Contents
SOAP API Developer's Guide
SOAP Add RPC Parameter
This is a convenience tool for composing RPC requests or responses. It adds a parameter element to the first element in the body of the envelope, which represents the method in RPC requests. Use the XML tools to add complex data (not just a string) to the parameter by manipulating the returned ‘Parameter Element' node.
The <Body> element must have a child element (method element). Otherwise this tool fails. When using ‘SOAP Create Envelope', you must add a method element using ‘SOAP Add Body Element'. The ‘SOAP Create RPC Response' tool already adds a method element.
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 |
Qualified name of the parameter |
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 that namespace. |
Value |
IN |
String |
Optional. Value of the parameter |
Parameter Element |
OUT |
Node |
Node of the element that just has been added to the method element. |