soap

Provides methods for working with SOAP based Web Services.

Methods

authBasic(user, pass)

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

Parameters:
Name Type Description
user String Username.
pass String Password.

authBearer(token)

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

Parameters:
Name Type Description
token String Token.

authNTLM(user, pass, domain, workstation)

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.

get(wsdlUrl, method, args)→ {Object}

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= optionalObject containing the arguments.
Returns:
Object - The response object.

describe(wsdlUrl)→ {String}

Returns SOAP service description.

Parameters:
Name Type Description
wsdlUrl String URL pointing to the WSDL XML.
Returns:
String - JSON containing the service description.