Visual FoxPro

Send a Staged Form-URL-Encoded REST Request

Demonstrates Rest.SendReqFormUrlEncoded, which sends an application/x-www-form-urlencoded request whose body is built from the query parameters added to the object.

Background. The staged request model separates sending from reading: a SendReq method transmits the request, ReadResponseHeader reads the status line and headers, and a ReadResp method reads the body. This gives fine control over large or streamed messages compared with the single-call full-request methods.

Chilkat Visual FoxPro Downloads

Download Chilkat for Visual FoxPro

Visual FoxPro

LOCAL lnSuccess
LOCAL loRest
LOCAL lnBTls
LOCAL lnBAutoReconnect
LOCAL lnStatusCode
LOCAL lcResponseBody

lnSuccess = 0

loRest = CreateObject('Chilkat.Rest')
lnBTls = 1
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("example.com",443,lnBTls,lnBAutoReconnect)
IF (lnSuccess = 0) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    CANCEL
ENDIF

*  The form body is built from the query parameters added to the object.
loRest.AddQueryParam("username","alice")
loRest.AddQueryParam("action","login")

*  Send the application/x-www-form-urlencoded request.
lnSuccess = loRest.SendReqFormUrlEncoded("POST","/api/login")
IF (lnSuccess = 0) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    CANCEL
ENDIF

*  After sending, read the response status line and header fields.  The return value is the HTTP
*  status code, or -1 if no response was received.
lnStatusCode = loRest.ReadResponseHeader()
IF (lnStatusCode < 0) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    CANCEL
ENDIF

? "Response status code: " + STR(lnStatusCode)

*  Read the response body as text.
lcResponseBody = loRest.ReadRespBodyString()
IF (loRest.LastMethodSuccess = 0) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    CANCEL
ENDIF

? lcResponseBody

RELEASE loRest