SOAPRunXML (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Communication / SOAP

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

SOAPRunXML (Function)

In french: SOAPExécuteXML

Warning
From version 2024, this function is kept for backward compatibility.

Runs a procedure on a SOAP server. All the procedure parameters must be specified via an XML message.

Remark: SOAPPrepare is used to create the entire XML message (encoded in UTF8) for a procedure of an imported web service.

Example

See additional examples

// Define the XML message of the "getTemp" procedure that
// returns the temperature of a city identified by its postal code
MessageXML = ...
	"<SOAP-ENV:Envelope xmlns:SOAP-ENV=" + ...
	"http://schemas.xmlsoap.org/soap/envelope/" + ...
	"xmlns:xsi=""http://www.w3.org/1999/XMLSchema-instance""" + ...
	"xmlns:xsd=""http://www.w3.org/1999/XMLSchema"">" + ...
	"<SOAP-ENV:Body> "+...
	"<ns1:getTemp xmlns:ns1=""urn:xmethods-Temperature"" SOAP-" + ...
	"ENV:encodingStyle=""http://schemas.xmlsoap.org/soap/encoding/"">" + ...
	"<zipcode xsi:type=""xsd:string"">94041</zipcode> " + ...
	"</ns1:getTemp> " + ...
	"</SOAP-ENV:Body> " + ...
	"</SOAP-ENV:Envelope>"

// Run the "getTemp" procedure
ResExecute = SOAPRunXML("http://services.xmethods.net:80" + ...
						  "/soap/servlet/rpcrouter", MessageXML)

Syntax

<Result> = SOAPRunXML(<URL of SOAP server> , <XML message> [, <Procedure action>])

<Result>: Boolean

True if the communication was established with the SOAP server,
False otherwise. To get more details on the error, use ErrorInfo.

<URL of SOAP server>: Character string

URL of SOAP server to contact. This parameter is supplied in the documentation of SOAP server.

<XML message>: Character string

XML message containing the data used to run a procedure (name, namespace, encoding style and parameters of procedure). These parameters are supplied in the documentation of the SOAP server and its procedures.
Remark: If you are using a WINDEV SOAP server, the name of the library (WDL) is specified via the namespace ("<Name of Server application>" becomes "c:\modulessoap\<Name of Server application>.wdl" on the server).

<Procedure action>: Optional character string

Action of procedure (also called "SOAPAction"). This parameter is supplied in the documentation of SOAP server.

Remarks

After the call to SOAPRunXML:

The data found in the procedure is erased.
The structure of the header specified with SOAPAddHeader is deleted.
SOAPGetResult returns the result of the procedure run.
SOAPError returns the error message of the procedure run.

Business / UI classification: Business Logic

Component: wd290com.dll