Xbase++

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 Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oRest
LOCAL nBTls
LOCAL nBAutoReconnect
LOCAL nStatusCode
LOCAL cResponseBody

nSuccess := 0

oRest := CreateObject("Chilkat.Rest")
nBTls := 1
nBAutoReconnect := 1
nSuccess := oRest:Connect("example.com", 443, nBTls, nBAutoReconnect)
IF (nSuccess == 0)
    ? oRest:LastErrorText
    oRest:destroy()
    RETURN
ENDIF

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

//  Send the application/x-www-form-urlencoded request.
nSuccess := oRest:SendReqFormUrlEncoded("POST", "/api/login")
IF (nSuccess == 0)
    ? oRest:LastErrorText
    oRest:destroy()
    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.
nStatusCode := oRest:ReadResponseHeader()
IF (nStatusCode < 0)
    ? oRest:LastErrorText
    oRest:destroy()
    RETURN
ENDIF

? "Response status code: " + Str(nStatusCode)

//  Read the response body as text.
cResponseBody := oRest:ReadRespBodyString()
IF (oRest:LastMethodSuccess == 0)
    ? oRest:LastErrorText
    oRest:destroy()
    RETURN
ENDIF

? cResponseBody

oRest:destroy()