Lianja

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 Lianja Downloads

Download Chilkat for Lianja

Lianja

llSuccess = .F.

loRest = createobject("CkRest")
llBTls = .T.
llBAutoReconnect = .T.
llSuccess = loRest.Connect("example.com",443,llBTls,llBAutoReconnect)
if (llSuccess = .F.) then
    ? loRest.LastErrorText
    release loRest
    return
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.
llSuccess = loRest.SendReqFormUrlEncoded("POST","/api/login")
if (llSuccess = .F.) then
    ? loRest.LastErrorText
    release loRest
    return
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
    return
endif

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

//  Read the response body as text.
lcResponseBody = loRest.ReadRespBodyString()
if (loRest.LastMethodSuccess = .F.) then
    ? loRest.LastErrorText
    release loRest
    return
endif

? lcResponseBody


release loRest