apiRequest (Type of request)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Communication / Web services

Properties specific to apiRequest variables
Handling different MIME types when requesting a web service

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

REST web service: Importing an API from OpenAPI

apiRequest (Type of request)

In french: apiRequête

The apiRequest type is used to define all the advanced characteristics of a request executed via a REST web service imported using the OpenAPI documentation. These characteristics can be defined and changed using different WLanguage properties.

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

New in version 2025

This type of variable is now available for iPhone/iPad applications.

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

This type of variable is now available for Android applications.

Example

Req is apiRequest
Req.HTTPHeader["key"] = "Value"
// Call a REST web service entry point 
// passing the header and the expected parameters
MyWebService.GetUserList(Req, param1_WS, param2_WS)

Properties

Properties specific to apiRequest variables

The following properties can be used to define the characteristics of apiRequest variables:

Property name	Type used	Effect

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 is set to an empty string (""), the default certificate is reset to "<None>".
HTTPHeader	Associative array of strings	Key/Value set of headers to send. Usage example of this property: `cMyRequest.HTTPHeader["Authorization"] = ... " WSSE profile=""UsernameToken""" cMyRequest.HTTPHeader["X-WSSE"] = ... "UsernameToken Username=blahblah " cMyRequest.Header["Cache-Control"] = " no-cache"`
ClientCertificatePassword	Character string or Secret string	Password associated with the client certificate (empty string by default). New in version 2025 Secret strings: The secret string can be of one of the following types: Ansi string - Latin, Ansi or Unicode string, Unicode string.. To learn more about secret strings and how to use the vault, see Secret string vault.
ConnectionTimeout	Integer or Duration	Maximum timeout for the connection expressed in milliseconds (20 seconds by default, i.e. 20000 milliseconds). This property can correspond to: an integer representing the number of milliseconds, a Duration variable, the duration in a readable format (e.g., 20 s or 20000 ms). The connection fails if it cannot be established within this period.

Remarks

Handling different MIME types when requesting a web service

When using a web service, web service functions can expect different Mime types in their parameters.

If the Mime type of the request is different from JSON, serialization is required.

Example:

Creation of the element to be passed to the API:

// Create an Author element (type defined by the API)
Author is TO 'Library Management API'.Author
Author.id = 12
Author.name = "Molière"
Author.birthDate = "16091205"
Author.nationality = "French"

The MIME type of the request is "application/json":

APIReqJSON is apiRequest
APIReqJSON..HTTPHeader["Content-Type"] = mimeTypeJSON
'Library Management API'._authorspost(APIReqJSON, "token",author)

The MIME type of the request is different from application/json (e.g. application/xml): serialization is required:

// Serialize the author before passing it as a parameter to the API
sAuthor is TO string
oXml is xmlNode = JSONToXML(author)
sAuthor = oXml..XMLSource

APIReqXML is apiRequest
APIReqXML..HTTPHeader["Content-Type"] = mimeTypeXMLApplication
Library Management API'._authorspost(APIReqXML, "token",sAuthor)