Xojo Plugin

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 Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

Dim rest As New Chilkat.Rest
Dim bTls As Boolean
bTls = True
Dim bAutoReconnect As Boolean
bAutoReconnect = True
success = rest.Connect("example.com",443,bTls,bAutoReconnect)
If (success = False) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

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

//  Send the application/x-www-form-urlencoded request.
success = rest.SendReqFormUrlEncoded("POST","/api/login")
If (success = False) Then
    System.DebugLog(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 Int32
statusCode = rest.ReadResponseHeader()
If (statusCode < 0) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

System.DebugLog("Response status code: " + Str(statusCode))

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

System.DebugLog(responseBody)