AddParam Method

Adds a parameter-value pair.

Syntax

soap.addParam(paramName, paramValue, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Please refer to the parameter name and value provided in the Params properties for more information on SOAP parameters and how they are managed.

Example (Send SOAP Request)


SOAPControl.Reset()
SOAPControl.AddParam("paramname", "paramvalue")
SOAPControl.AddParam("paramname", "paramvalue")
SOAPControl.MethodURI = "methoduri"
SOAPControl.Method = "methodname"
SOAPControl.URL = "endpointURL"
SOAPControl.SendRequest()
Example (Send SOAP Request using Param Arrays)
SOAPControl.Reset()
SOAPControl.ParamCount = 2
SOAPControl.ParamName(0) = "paramname"
SOAPControl.ParamValue(0) = "paramvalue"
SOAPControl.ParamName(1) = "paramname2"
SOAPControl.ParamValue(1) = "paramvalue2"
SOAPControl.ParamAttrs(1) = "customattr=value"
SOAPControl.MethodURI = "methoduri"
SOAPControl.Method = "methodname"
SOAPControl.URL = "endpointURL"
SOAPControl.SendRequest()

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 Node.js Edition - Version 20.0 [Build 8307]