RESTSend (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

RESTSend (Function)

In french: RESTEnvoie

Sends a REST request and waits for the server response.

Example

cMyRequest is restRequest
cMyRequest.URL = "<server address>"
cMyResponse is restResponse = RESTSend(cMyRequest)
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 restRequest
cMyRequest.Method = httpGet
cMyRequest.URL = "http://<Server IP>/CDM/UpdateTopBar/1"
//Where CDM is the common component and 1 the parameter value

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

Syntax

Syntax that is using a restRequest variable Hide the details

<REST response> = RESTSend(<REST request>)

<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.

Simplified syntax for sending a request Hide the details

<REST response> = RESTSend(<URL>)

<REST response>: restResponse variable

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

<URL>: Character string

URL to interrogate.

Asynchronous syntax that is using a restRequest variable Hide the details

RESTSend(<HTTP request> , <WLanguage procedure>)

<HTTP request>: httpRequest variable

Name of the restRequest variable that contains the characteristics of the REST request to be sent to the 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.

Simplified asynchronous syntax for sending a request Hide the details

RESTSend(<URL> , <WLanguage procedure>)

<URL>: Character string

URL to interrogate.

<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: wd270com.dll

See also

Minimum version required

Version 20

This page is also available for…

Comments

Video httpput

PROPAGANDA AULA 2025 RESTREQUEST
https://youtu.be/cJZm-WrAPgM
AULA COMPLETA 2025 RESREQUEST
https://youtu.be/d3zULOtHQjs
https://windevdesenvolvimento.blogspot.com/2019/02/dicas-2025-windev-mobile-webservice-021_23.html
// BTN_ALTERA_httpPut
solicitacao_http is restRequest
URL is string="http://nots-amarildo/empresa/{nEmpresaId}"
URL = Replace(URL,"{nEmpresaId}","2")
solicitacao_http..URL=URL
solicitacao_http..ContentType="application/json"
solicitacao_http..Method=httpPut
solicitacao_http..Content=[
{
"razao_social"
:
"ALTERADO1205"
}
]
resposta_http is restResponse = RESTSend(solicitacao_http)
EDT_RETORNO=resposta_http..Content

amarildo

23 Feb. 2019

Video RestSend

PROPAGANDA DA AULA PRIVADA RESTSEND
https://youtu.be/933LvEUWFIA
AULA PRIVADA COMPLETA RESTSEND SOMENTE PARA COLABORADORES GRUPO PRIVADO
https://youtu.be/LfOcn4tyBww
https://windevdesenvolvimento.blogspot.com/2019/02/dicas-2024-windev-mobile-webservice-020.html

// BTN_ADICIONA_httpPost
solicitacao_http is restRequest
solicitacao_http..URL="http://nots-amarildo/empresa"
solicitacao_http..Method=httpPost
solicitacao_http..ContentType="application/json"
solicitacao_http..Content=[
{
"razao_social"
:
"NOVO0645"
}
]
resposta_http is restResponse=RESTSend(solicitacao_http)
IF ErrorOccurred THEN
Error(ErrorInfo(errFullDetails))
ELSE
EDT_RETORNO=resposta_http..Content
END

amarildo

22 Feb. 2019

Video RestSend

https://youtu.be/G7oY3hd7Jo0

https://windevdesenvolvimento.blogspot.com/2019/02/dicas-2023-windev-mobile-webservice-019.html

solicitacao_http is restRequest
sUrl is string="http://localhost/empresa/{nEmpresaid}"
sUrl=Replace(sUrl,"{nEmpresaid}","2")
solicitacao_http..URL=sUrl
solicitacao_http..Method=httpGet
resposta_http is restResponse = RESTSend(solicitacao_http)
IF ErrorOccurred THEN
Error(ErrorInfo(errFullDetails))
ELSE
EDT_RETORNO=resposta_http..Content
END

amarildo

22 Feb. 2019

Video RestSend

https://youtu.be/VvMa-5kUZkQ

https://windevdesenvolvimento.blogspot.com/2019/02/dicas-2022-windev-mobile-webservice-018.html

solicitacao_http is restRequest
solicitacao_http..URL="http://nots-amarildo/empresa"
solicitacao_http..Method=httpGet
resposta_http is restResponse = RESTSend(solicitacao_http)
IF ErrorOccurred THEN
Error(ErrorInfo(errFullDetails))
ELSE
EDT_RETORNO=resposta_http..Content
END

amarildo

20 Feb. 2019

Last update: 05/26/2022

Send a report | Local help