restRequest (Type of variable)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Properties specific to the description of restRequest variables
Managing redirections
HTTP cookies

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

restRequest (Type of variable)

In french: restRequête

The restRequest type is used to define the advanced characteristics of a REST request. The characteristics of the REST request can be defined and modified using different WLanguage properties.

Remark: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.

Versions 22 and later

This type of variable is now available in Android Widget mode.

This type of variable is now available for Android applications.

This type of variable is now available in browser code.

New in version 22

This type of variable is now available in Android Widget mode.

This type of variable is now available for Android applications.

This type of variable is now available in browser code.

This type of variable is now available in Android Widget mode.

This type of variable is now available for Android applications.

This type of variable is now available in browser code.

Example

cMyRequest is restRequest
cMyRequest.URL = "http://www.windev.com"
cMyResponse is restResponse = RESTSend(cMyRequest)
IF ErrorOccurred THEN
Error(ErrorInfo(errFullDetails))
ELSE
Info(cMyResponse.Content)
END

Remarks

Properties specific to the description of restRequest variables

The following properties can be used to handle a REST request:

Property name	Type used	Effect

UserAgent	Character string	Identifies the client. The default value is "PC SOFT Framework". The content of the response may depend on the user agent (for example, a request performed from a Mobile device and a request performed from a PC browser may require different pages). In this case, see the documentation of user agent for more details. Not available.
Versions 22 and later AuthToken New in version 22 AuthToken AuthToken	AuthToken variable	Token for accessing a Webservice that will be used in case of authentication via the OAuth 2.0 protocol. This access token is retrieved by AuthIdentify. The access token is automatically passed to the access_token parameter on the URL. If the parameter must be different, the URL to run must be built by yourself. Not available.
UploadProgress	httpProgress variable	Notification of progress status when uploading POST data.
DownloadProgress	httpProgress variable	Notification of progress status of download.
Versions 24 and later ClientCertificate New in version 24 ClientCertificate ClientCertificate	String or buffer	Corresponds to: a character string with an access path to the .p12 file that contains the certificate to attach to the request. The certificate will be automatically loaded taking into account: the certificate in the executable library (if it has been integrated into the application), the certificate at the specified location on disk (if the certificate has not been integrated into the executable library). a buffer with the certificate (fLoadBuffer). If this property corresponds to an empty string (""), the default certificate is reset to "<None>".
ContentType	Character string	Type of content of the message to send to the server. This property is taken into account only if the sending method (Method property) allows it. By default, the message type corresponds to: "application/x-www-form-urlencoded". However, you have the ability to use any value, for example: "text/xml", "application/javascript", "application/json", "application/xml", "image/jpeg", ... To send rough data that will be read at once by the WEBDEV application server, use the following types: "application/octet-stream". "text/xml".
Content	Buffer	Message to send to the server. This property is taken into account only if the sending method (Method property) allows it. The message to send must comply with the HTTP protocol used. By default, if this property is specified and if it is not empty, the method used is a POST request ; otherwise, it is a GET request.
Versions 26 and later ResponseRawContent New in version 26 ResponseRawContent ResponseRawContent	Boolean	Indicates whether the Content property corresponds to the raw content: True: the Content property corresponds to a buffer. No modification is performed. False (Default value): the content is modified by the browser. In particular, UTF-8 text is automatically decoded. the Content property returns the result as a string.
Versions 25 and later MaxUploadRate New in version 25 MaxUploadRate MaxUploadRate	Integer	Maximum data upload speed in kilobytes per second. This speed is given for information only. 0 (default value) means that this speed is not limited. Not available.
Versions 25 and later MaxDownloadRate New in version 25 MaxDownloadRate MaxDownloadRate	Integer	Maximum data download speed in kilobytes per second. This speed is given for information only. 0 (default value) means that this speed is not limited. Not available.
Versions 24 and later Destination New in version 24 Destination Destination	Character string	Full path of the query result backup file. Not available.
Timeout	Integer	Maximum response timeout (in milliseconds). This property can correspond to: an integer corresponding to the number of milliseconds, a Duration variable, Versions 23 and later the duration in a readable format (e.g., 1 s or 10 ms). New in version 23 the duration in a readable format (e.g., 1 s or 10 ms). the duration in a readable format (e.g., 1 s or 10 ms). This property is set to 20 seconds by default. Remark: The timeout defined by HTTPTimeOut has no influence on this property. Not available.
Header	Associative array of character strings	Key/Value set of headers to send. Example for using this property: cMyRequest is restRequest cMyRequest.Header["Authorization"] = ... " WSSE profile=""UsernameToken""" cMyRequest.Header["X-WSSE"] = ... "UsernameToken Username=blahblah " cMyRequest.Header["Cache-Control"] = " no-cache"
IgnoreError	Integer constant	Specifies the ignored errors. Corresponds to a constant or to a combination of constants: httpIgnoreInvalidCertificate: The certificate is ignored. httpIgnoreInvalidCertificateName: The site name specified in the certificate is ignored. httpIgnoreExpiredCertificate: The certificate date is ignored. Versions 21 and later httpIgnoreRedirection: The redirection to a page is ignored. New in version 21 httpIgnoreRedirection: The redirection to a page is ignored. httpIgnoreRedirection: The redirection to a page is ignored. httpIgnoreRedirectToHTTP: The redirection to a non-secure server is allowed. httpIgnoreRedirectToHTTPS: The redirection to a secure server is allowed. Versions 22 and later Only the following errors are supported: httpIgnoreExpiredCertificate, httpIgnoreInvalidCertificate, httpIgnoreInvalidCertificateName, httpIgnoreRevocation, httpIgnoreRedirection. New in version 22 Only the following errors are supported: httpIgnoreExpiredCertificate, httpIgnoreInvalidCertificate, httpIgnoreInvalidCertificateName, httpIgnoreRevocation, httpIgnoreRedirection. Only the following errors are supported: httpIgnoreExpiredCertificate, httpIgnoreInvalidCertificate, httpIgnoreInvalidCertificateName, httpIgnoreRevocation, httpIgnoreRedirection. Not available.
Method	Integer constant	HTTP method used: httpCopy: COPY method. httpDelete: DELETE method. httpGet: GET method. httpHead: HEAD method. Versions 25 and later httpLock: Lock method (WebDAV protocol). New in version 25 httpLock: Lock method (WebDAV protocol). httpLock: Lock method (WebDAV protocol). Versions 25 and later httpMkCol: MkCol method (WebDAV protocol). New in version 25 httpMkCol: MkCol method (WebDAV protocol). httpMkCol: MkCol method (WebDAV protocol). Versions 25 and later httpMove: Move method (WebDAV protocol). New in version 25 httpMove: Move method (WebDAV protocol). httpMove: Move method (WebDAV protocol). httpPatch: PATCH method. httpPost: POST method. Versions 25 and later httpPropFind: PROPFIND method (WebDAV protocol). New in version 25 httpPropFind: PROPFIND method (WebDAV protocol). httpPropFind: PROPFIND method (WebDAV protocol). Versions 25 and later httpPropPatch: PROPPATCH method (WebDAV protocol). New in version 25 httpPropPatch: PROPPATCH method (WebDAV protocol). httpPropPatch: PROPPATCH method (WebDAV protocol). httpPut: PUT method. Versions 25 and later httpUnlock: Unlock method (WebDAV protocol). New in version 25 httpUnlock: Unlock method (WebDAV protocol). httpUnlock: Unlock method (WebDAV protocol). If the Content property is not empty, the httpPost method is used by default. Otherwise, the httpGet method is used.
Password	Character string	Password associated with the user name (empty string by default). Used to access a page with a protected URL. Caution: The password is not encrypted when it is sent over the Internet. Remark: If the UserName and Password properties are specified, the corresponding "Authorization:Basic" header is automatically generated in the request header.
Versions 24 and later ClientCertificatePassword New in version 24 ClientCertificatePassword ClientCertificatePassword	Character string	Password associated with the client certificate (empty string by default)
Versions 24 and later ProcedureTrace New in version 24 ProcedureTrace ProcedureTrace	Procedure	Name of the WLanguage procedure used to identify the data and headers that have been sent. This procedure has the following format: PROCEDURE <Procedure name>(<InfoType> is int, <Data> is Buffer) where: <InfoType> is an integer constant that corresponds to the type of data being traced: httpTraceDataSent: Data sent. Versions 26 and later httpTraceDataReceived: Data received. New in version 26 httpTraceDataReceived: Data received. httpTraceDataReceived: Data received. httpTraceHeaderSent: Header sent. Versions 26 and later httpTraceHeaderReceived: Header received. New in version 26 httpTraceHeaderReceived: Header received. httpTraceHeaderReceived: Header received. <Data> is a buffer that contains the information. Example of procedure: PROCEDURE ProcTrace(nInfoType is int, ... bufByData is Buffer) SWITCH nInfoType CASE httpTraceHeaderSent Trace("Header: ", ... UTF8ToString(bufByData)) CASE httpTraceDataSent: Trace("Data: ", ... bufByData) CASE httpTraceHeaderReceived: Trace("Header received: ", ... UTF8ToString(bufByData)) CASE httpTraceDataReceived: Trace("Data received: ", ... bufByData) END Not available.
Versions 21 and later ConnectionTimeout New in version 21 ConnectionTimeout ConnectionTimeout	Integer	Maximum timeout for the connection expressed in milliseconds (20 seconds by default, which means 20000 milliseconds). This property can correspond to: an integer corresponding to the number of milliseconds, a Duration variable, Versions 23 and later the duration in a readable format (e.g., '20s' ou '20000ms'). New in version 23 the duration in a readable format (e.g., '20s' ou '20000ms'). the duration in a readable format (e.g., '20s' ou '20000ms'). The connection fails if it cannot be established after this timeout (RESTSend will return an error, in the restResponse result variable). Not available.
URL	Character string	Address of server to contact (URL address). This URL can contain: the port number for connecting to the server. The default value is 80 in HTTP (corresponds to a server of Web pages) and 443 in HTTPS. To specify a port number, use the following format: "<Server URL>:<Port #>". For example: http://www.windev.com:80. additional parameters. These parameters can be used to perform a search or to fill a form. For example, to find "windev" on "http://www.google.com", the URL to contact will be: "http://www.google.com/search?q=windev". Remarks: To specify both the port number and additional parameters, use the following format: "<Server URL>:<Port #>/<Additional parameters>". To perform a secure transaction, the URL must start with "https://". In this case, the management mode of requests is always performed by Internet Explorer (see HTTPParameter for more details).
User	Character string	Name used to access a page with a protected URL (empty string by default). This name is used to identify the user. Remark: If the UserName and Password properties are specified, the corresponding "Authorization:Basic" header is automatically generated in the request header.
Versions 26 and later VersionHTTP New in version 26 VersionHTTP 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.
Versions 22 and later VersionSSL New in version 22 VersionSSL VersionSSL	Integer constant	SSL version used: ProtocolDefault: Default protocol (TLS 1.2). ProtocolTLS1: TLS1 protocol. ProtocolTLS1_1: TLS1.1 protocol. ProtocolTLS1_2: TLS1.2 protocol. Not available.

Managing redirections

Versions 21 and later
Redirections are supported by default. To ignore redirections, use the httpIgnoreRedirection constant in the IgnoreError property.

New in version 21
Redirections are supported by default. To ignore redirections, use the httpIgnoreRedirection constant in the IgnoreError property.

Redirections are supported by default. To ignore redirections, use the httpIgnoreRedirection constant in the IgnoreError property.

HTTP cookies

The cookies received in response to a call to RESTSend are stored while waiting for a future call to RESTSend on the same domain: the restRequest variable is updated.
For more details, see HTTPCookieManage.