XmlInvoke

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > Altri servizi > Soap >

XmlInvoke

Service

Soap

 

Method

XmlInvoke

 

Description

Invokes a WSDL operation returning a String containing an XML structure.

 

Input

Name

Description

Type

Optional

wsdlUrl

Url of the service WSDL (ex.: "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL"); see remarks

String

 

serviceAddress

Service address, if different from the address contained in the wsdlUrl or in the WSDL (ex.: "http://www.webservicex.net/CurrencyConvertor.asmx"); see remarks

String

 

wsdlStream

A reference of an attachment containing WSDL: it is needed only if the wsdlUrl is null or empty; see remarks

Reference

 

operationName

Operation name (ex.: "ConversionRate")

String

 

soapHeaderName

Custom header name (ex.: "AuthHeader")

String

 

soapHeaderValues

Dataset containing Key/Value pairs of the custom header properties (ex. ["UserName"/"test"], ["PassWord"/"test"])

Dataset

 

xmlBody

Xml string to insert between "<soap:Body>" and "</soap:Body>" in the request.

String

 

values

Optional dataset containing Key/Value pairs of token/value to replace in xmlBody; ex.: if xmlBody = "<Currency>@Currency@</Currency>" and tokenDelimiter = "@" and values contains ["Currency", "EUR"], xmlBody will become "<Currency>EUR</Currency>".

Dataset

Y

tokenDelimiter

The token delimiter (defaults to "@").

String

 

userAgent

The user-agent header value (ex.: ".NET Framework Test Client").

(Defaults to the "UserAgent" configuration field, if specified)

String

 

timeout

The number of milliseconds to wait before the request times out.

(Defaults to the "Timeout" configuration field, if specified, otherwise to 100000 [100 seconds])

Int

 

credentialsType

Type of the authentication credentials associated with the request:

   1 = None (network credentials not required)

   2 = NetworkCredentials ("userName" and "password" must be specified)

   3 = DefaultNetworkCredentials (the network credentials of the current security context)

   4 = DefaultCredentials (the system credentials of the application)

   5 = WSSE Security ("userName" and "password" must be specified)

   (Defaults to the "CredentialsType" configuration field, if specified, otherwise to 1 [None])

Int

 

userName

User name (required if "CredentialsType" = 2).

Defaults to the "UserName" configuration field, if specified)

String

 

password

Password (required if "CredentialsType" = 2).

(Defaults to the "Password" configuration field, if specified)

String

 

httpHeaderValues

Dataset containing Key/Value pairs of http headers (ex. ["Pd_application_id"/"-1"])

Dataset

 

Output

Name

Description

Type

Optional

returnValue

A String containing the XML returned by the SOAP invocation.

String

 

 

Remarks

Service address: it is taken (in order of priority) from the serviceAddress parameter, from the address specified in the WSDL or from the wsdlUrl.

WSDL: it is taken (in order of priority) from the wsdlUrl or from the wsdlStream parameter; the wsdlUrl parameter can contain the url to download the wsdl from the service (ex.: "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL") or a file url to download it from the file system (ex.: "C:\CurrencyConvertor\CurrencyConvertorWsdl.xml" or "file:///C:/CurrencyConvertor/CurrencyConvertorWsdl.xml" or "file://loaclhost/C:/CurrencyConvertor/CurrencyConvertorWsdl.xml").