B4X

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

Download Chilkat for B4X

B4X

Dim success As Boolean = False

Dim rest As ChilkatRest
rest.Initialize("rest")
Dim bTls As Boolean = True
Dim bAutoReconnect As Boolean = True
success = rest.Connect("example.com", 443, bTls, bAutoReconnect)
If success = False Then
    Log(rest.LastErrorText)
    Return
End If


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

'  Send the application/x-www-form-urlencoded request.
success = rest.SendReqFormUrlEncoded("POST", "/api/login")
If success = False Then
    Log(rest.LastErrorText)
    Return
End If


'  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.
Dim statusCode As Int = rest.ReadResponseHeader
If statusCode < 0 Then
    Log(rest.LastErrorText)
    Return
End If

Log("Response status code: " & statusCode)

'  Read the response body as text.
Dim responseBody As String = rest.ReadRespBodyString
If rest.LastMethodSuccess = False Then
    Log(rest.LastErrorText)
    Return
End If

Log(responseBody)