<restRequest variable>.Send (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Communication / HTTP functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<restRequest variable>.Send (Function)

In french: <Variable restRequête>.Envoie

Sends a REST request and waits for the server response.

Example

cMyRequest is httpRequest
cMyRequest.URL = "<server address>"
cMyResponse is httpResponse = cMyRequest.Send()
IF ErrorOccurred THEN
Error(ErrorInfo(errFullDetails))
ELSE
Info(cMyResponse.Content)
END

// The code sample below explains how to call a WINDEV REST Webservice with parameters.
// The procedure found in the Webservice has the following format:
// PRIVATE PROCEDURE UpdateTopBar(bTestMode is boolean)

// The test URL has the following format:
// http://<Server IP>/<Common component>
//?test

// WLanguage code used to call it by passing the parameter
cMyRequest is httpRequest
cMyRequest.Method = httpGet
cMyRequest.URL = "http://<Server IP>/CDM/UpdateTopBar/1"
//Where CDM is the common component and 1 the parameter value

cMyResponse is httpResponse = cMyRequest.Send()
IF ErrorOccurred THEN
Error(ErrorInfo(errFullDetails))
ELSE
IF cMyResponse.Content = True THEN
Info("The site was updated.")
ELSE
Error(cMyResponse.Content)
END
END

Syntax

Synchronous syntax: wait for the reply Hide the details

<REST response> = <REST request>.Sends()

<REST response>: restResponse variable

Name of restResponse variable containing the response received from the REST server.

<REST request>: restResponse variable

Name of the restRequest variable that contains the characteristics of the REST request to be sent to the server.

Asynchronous syntax Hide the details

<REST request>.Sends(<WLanguage procedure>)

<REST request>: restResponse variable

Name of restResponse variable containing the response received from the REST server.

<WLanguage procedure>: Procedure name

Name of WLanguage procedure called during the response from the REST server. This procedure has the following format:
PROCEDURE <Procedure name>(<Response> is restResponse)
where <Response> is a restResponse variable containing the response received from the REST server.

Remarks

To find out the runtime errors of this function, use ErrorOccurred and ErrorInfo.
Access to REST APIs from a domain other than the one hosting the site from a browser code (Cross-domain) is blocked by default (Cross-Origin Request Blocked). To avoid being blocked, specific authorizations must be configured on the Web server. This topic is covered in the following post on the support blog: https://blogs.pcsoft.fr/fr/autoriser-acces-api-rest-domaine-cors

Business / UI classification: Business Logic

Component: wd280com.dll