• How to import a web service into a project.
• How to update the description of a web service in a project.
• How to use a web service in a project.
• How to distribute a WINDEV application that uses a web service.

Using a web service in a Java project requires a Java virtual machine (JRE) in version 6 (or 6.1) or later.

Import

1. On the "Project" tab, in the "Project" group, expand "Import" and select "A web service".
   
   The web service import wizard starts.
2. In the wizard, the presentation screen is displayed. Go to the next step.
3. Specify the location of the WSDL. This file corresponds to the web service description. It contains the description of each function found in the web service as well as their parameters.
   
   Two methods can be used to locate the WSDL:
   • from a URL, HTTP address where the WSDL is found.
     Remarks:
     • You have the ability to specify the username and the password if an authentication is required.
     • The "Proxy" button is used to configure the proxy options if necessary.
   • from an XML file found on the current computer.
4. Finish the wizard. A message is displayed, indicating that the import is ended.
   
5. The Web service is automatically added to the "Project Explorer" pane (in the "Imported Webservices" branch).. It is ready to use.

"Project explorer" pane: viewing a web service

The imported Web service is displayed in the "Project Explorer" pane, "Imported Webservices" folder.:

• the name of the web service.
• the name of each function.
• the name of a structure containing either the call parameters, or the return values.
• the name of each variable in the structure.

Updating the description of a web service

1. Select the web service in the "Project explorer" pane.
2. Select "Update" from the popup menu.

Properties of a web service modifiable in the editor

1. Select the web service in the "Project explorer" pane.
2. Select "Description" in the context menu.
3. The window of properties is displayed. The following properties can be modified in this window:
   • The import address of web service: it is the URL to the WSDL describing the web service.
   • The username and the password used to import the WSDL.

Principle

1. Declare 2 variables: a variable used to specify the call parameters and a variable used to retrieve the response.
2. Initialize each variable of the call structure.
   Important: the order of assignment of variables is used in the XML generated in the SOAP request. It is therefore necessary to assign the variables in the order specified in the documentation of the web service function.
3. Call the web service function by passing the call variable as parameter and retrieve the response variable in return.

trackingSearch is trackSearch
trackingSearchRes is resultTrackSearch
trackingSearch.accountNumber = 99999999
trackingSearch.consigneesCountry = "FR"
trackingSearch.consigneesZipCode = "37100"
trackingSearch.sendersRef = "111111"
trackingSearchRes = TrackingServiceWSService.trackSearch(trackingSearch)

IF ErrorOccurred() THEN
	Trace("Echec de l'appel au service Web : " + ErrorInfo(errFullDetails))
ELSE
	Trace("Webservice correctement exécuté")
END

How to set values in the HTTP header of a SOAP web service call?

1. Declare a wsRequest variable.
2. Use the HTTPHeader property to set the header values.
3. Call the web service procedure by specifying the name of the wsRequest variable as the first parameter.

C is wsRequest
C.HTTPHeader["key"] = "Value"
// Call the web service procedure 
// passing the header and the expected parameters
WebServiceProc(C, param1_WS, param2_WS)
// Displays the request sent
Trace(C.XMLSource)

Properties associated with the web service

nom	Type used	Effect
Address	Character string	Used to replace the call address of web service described in the WSDL by another URL. This property is useful if the web service is hosted on different servers. This property has the following format: "http://server:port/webservice_path". For a web service generated with WINDEV and deployed on a WEBDEV Application Server, it is the URL of the "awws" file. Remarks: The modification of this property replaces all the URLs described in the WSDL. If this property corresponds to an empty string (""), the URLs described in the WSDL will be re-used.
Authentication	Integer constant	Used to force the HTTP authentication method: auAutomatic (default value): automatic authentication method. auBasic: Basic authentication method. auNegotiate: Negotiate authentication method. Caution: This authentication method is not supported by Linux executables.
IgnoreError	Combination of constants	Used to ignore the certificate errors. the following constants can be used: httpIgnoreInvalidCertificate: Used to ignore an invalid certificate or a certificate coming from an unknown company. httpIgnoreInvalidCertificateName: Used to ignore the name of the site found in the certificate. httpIgnoreExpiredCertificate: Used to ignore the date of the certificate. httpIgnoreRedirectToHTTP: Used to redirect to a non-secure server. httpIgnoreRedirectToHTTPS: Used to redirect to a secure server. httpIgnoreRevocation: Used to ignore the check in the list of revoked certificates. Remarks: Only the following errors are supported: httpIgnoreExpiredCertificate, httpIgnoreInvalidCertificate, httpIgnoreInvalidCertificateName, httpIgnoreRevocation. The other errors are ignored. For backward compatibility, all the errors are ignored by default.
MethodHTTP	Integer constant	HTTP method used to call the web service: httpPost (default value): POST method httpPut: PUT method
Password	Character string	Password used for authentication in the HTTP requests sent to the web service. This name is used only if authentication is required to access the server where the web service is hosted.
Port	Character string	Name of the port defined in the WSDL. It is the port used to communicate with the server that hosts the web service. Contact your network manager or the owner of the web service.
User	Character string	Username used for authentication in the HTTP requests sent to the web service. This name is used only if authentication is required to access the server where the web service is hosted. With the Negotiate authentication method, the domain must be added to the user depending on the configuration: monWebservice..Utilisateur = "DOMAINE\Utilisateur" or monWebservice..Utilisateur = "Utilisateur@DOMAINE"
VersionHTTP	Integer constant	HTTP version used by the server: httpVersion2: HTTP version 2.0. If the server does not support this version, an older version is used. httpVersion2Only: Forces HTTP version 2.0: if the server does not support this version, a fatal error is displayed. httpVersion1_1: HTTP version 1.1. httpVersion1_0: HTTP version 1.0. httpVersionDefault: HTTP version 1.0.

• If a username and a password are specified, the authentication of the HTTP requests will be done by using the "Basic" authentication schema, in which the parameters are in readable format in the HTTP request. We recommend that you use HTTPS requests if the authentication is required.
• If the server that hosts the web service requires a Windows authentication in HTTP, HTTPConfigure must be called before consuming the web service (in order to use Internet Explorer for the HTTP requests).
• The maximum timeout can be specified with HTTPTimeOut.

Properties available on the types of variables

You cannot use a method that manages a shared context.

Advanced operations of the XML stream of the web service

Special case: the web service returns a result whose type is not recognized by WINDEV, WEBDEV and WINDEV Mobile

• If the web service returns a structure, the names of the members of the return structure are case-sensitive.
• If you are using a structure as parameter of a web service function and if a DATE member is not assigned, the following error will be displayed: "The 0000-00-00 value does not respect the XSD schema".