soap

Provides methods for working with SOAP based Web Services.

authBasic

Sets Basic Authentication details to be used for connections with the service.

Parameters:

Name	Type	Description
user	String	Username.
pass	String	Password.

authBearer

Sets Bearer Token Authentication details to be used for connections with the service.

Parameters:

Name	Type	Description
token	String	Token.

authClientSSL

Sets Client SSL Authentication details to be used for connections with the service.

Parameters:

Name	Type	Description
key	Buffer|String	Private key path or a Buffer containing the key.
cert	Buffer|String	Certificate path or a Buffer containing the certificate.
ca	Buffer|String|Array	CA path or a Buffer.
options	Object	optional Options.

authClientSSLPFX

Sets Client SSL (PFX) Authentication details to be used for connections with the service.

Parameters:

Name	Type	Description
pfx	Buffer|String	PFX path or a Buffer containing the PFX bundle.
passphrase	Buffer|String	optional Passphrase for the PFX.
options	Object	optional Options.

authNTLM

Sets NTLM Authentication details to be used for connections with the service.

Parameters:

Name	Type	Description
user	String	Username.
pass	String	Password.
domain	String	Domain.
workstation	String	Workstation.

describe

Returns SOAP service description.

Parameters:

Name	Type	Description
wsdlUrl	String	URL pointing to the WSDL XML.
wsdlHeaders	Object	optional custom HTTP headers to be sent on WSDL requests.

Returns:

Object - Service description.

get

Initiates a SOAP request and returns the response.

** Usage example:**

// get SOAP service description, so we can understand what methods it provides,
// what input parameters it expects, and what is the output structure.
var serviceUrl = 'http://www.dataaccess.com/webservicesserver/numberconversion.wso?WSDL';
var serviceDescription = soap.describe(serviceUrl);
log.info(serviceDescription);

// NumberToWords method in this service converts number to words.
var result = soap.get(serviceUrl, 'NumberToWords', { 'ubiNum': 2019 });
log.info(result.NumberToWordsResult);

Parameters:

Name	Type	Description
wsdlUrl	String	URL pointing to the WSDL XML.
method	String	Method name (case sensitive).
args	Object	optional Object containing the arguments.
wsdlHeaders	Object	optional custom HTTP headers to be sent on WSDL requests.

Returns:

Object - The response object.

getLastResponseHeaders

Returns last response headers.

Returns:

Object - IncomingHttpHeaders (https://microsoft.github.io/PowerBI-JavaScript/interfaces/node_modules__types_node_http2_d.http2.incominghttpheaders.html).

setProxy

Sets proxy url to be used for connections with the service.

Parameters:

Name	Type	Description
url	String	Proxy url. Invocation without arguments will remove any previously set url.