Visual FoxPro

Add a Query Parameter to a REST Request

Demonstrates Rest.AddQueryParam, which adds or replaces a query-string parameter. The 1st argument is the parameter name and the 2nd is its value; Chilkat URL-encodes both as needed.

Background. For a GET request the accumulated parameters are appended to the URL query string. For a form-url-encoded request the same parameters form the request body.

Chilkat Visual FoxPro Downloads

Download Chilkat for Visual FoxPro

Visual FoxPro

LOCAL lnSuccess
LOCAL loRest
LOCAL lnBTls
LOCAL lnBAutoReconnect
LOCAL lcResponseText

lnSuccess = 0

loRest = CreateObject('Chilkat.Rest')

*  Connect to the REST server.  The 3rd argument enables TLS (use 1 for HTTPS on port 443),
*  and the 4th enables automatic reconnection if the connection is dropped between requests.
lnBTls = 1
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("example.com",443,lnBTls,lnBAutoReconnect)
IF (lnSuccess = 0) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    CANCEL
ENDIF

*  Add query-string parameters.  The 1st argument is the parameter name and the 2nd is its value.
*  Chilkat automatically URL-encodes names and values as needed.
loRest.AddQueryParam("q","chilkat rest")
loRest.AddQueryParam("limit","10")

*  For a GET request the parameters are appended to the URL query string.
lcResponseText = loRest.FullRequestNoBody("GET","/api/search")
IF (loRest.LastMethodSuccess = 0) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    CANCEL
ENDIF

? lcResponseText

RELEASE loRest