Contents

SOAP Get RPC Parameter

This is a convenience tool for examining RPC requests. It retrieves a parameter element (child) from the first element in the <Body> element (method in an RPC request). It returns the first element that matches all of the specified arguments. If 'Base Name', 'Namespace', and 'Index' are undefined, the first element will be returned.

For example, to retrieve the 2^nd parameter from the 'Add' method in the calculator example presented in Listing 4, you would specify "Parameter2" as name and "" as namespace, or '1' as index.

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 parameter
Namespace	IN	String	Optional. Namespace of the parameter
Index	IN	Integer	Optional. Zero based index into parameters of the method. If this parameter is specified, 'Name' and 'Namespace' may be omitted, but if present must match the name and namespace of the parameter.
Retrieve Value	IN	Boolean	Checkbox: False Do not retrieve value True Default. Return node value Disable retrieval of value if parameter contains a large XML document and the value is not used (performance option).
Parameter Element	OUT	Node	Parameter element
Parameter Base Name	OUT	String	Base name of the parameter element
Parameter Namespace	OUT	String	Namespace URI of the parameter element
Parameter Index	OUT	Integer	Zero based index of the parameter element in the child list of the method element.
Value	OUT	String	Value of the parameter