OpenAPIToHTTP (Function)

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 / HTTP functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

OpenAPIToHTTP (Function)

In french: OpenAPIVersHTTP

Builds the HTTP request to call a function of an API.

Example

// Standard call that uses the full call to a WebService method
stParam1 is Param1
stParam1.String = "a string"
stParam1.Int = 2
stRet is MyResult
stRet = MyFunction(stParam1)

// Retrieve the Buffer for the call using OpenAPIToHTTP
stParam1 is Param1
stParam1.String = "a string"
stParam1.Int = 2
cMyRequest is httpRequest = OpenAPIToHTTP(MyFunction, stParam1)
HTTPSend(cMyRequest)

Syntax

<Result> = OpenAPIToHTTP(<Function> [, <Parameter 1> [... [, <Parameter N>]]])

<Result>: httpRequest variable

httpRequest variable corresponding to the generated HTTP request.

<Function>: Character string

Name of the function for which the HTTP request must be built.

<Parameter 1>: Optional variant

First parameter expected by the function.

<Parameter N>: Optional variant

Nth parameter expected by the function.

Remarks

OpenAPIToHTTP builds the HTTP request as a variable of type httpRequest, which can then be sent to the API using the following syntax:

<API function>([<Function parameter 1> [, ... [<Function parameter N>]]])

The generated request can then be sent using HTTPSend.

Component: wd300com.dll