Xojo Plugin

Send a Staged REST Request with a Text Body

Demonstrates Rest.SendReqStringBody, which sends a request whose text body (such as JSON) is supplied directly, then reads the response in separate steps.

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

success = rest.AddHeader("Content-Type","application/json")

//  Send a request whose text body (such as JSON) is supplied directly.
Dim jsonBody As String
jsonBody = "{ ""name"": ""example"" }"
success = rest.SendReqStringBody("POST","/api/items",jsonBody)
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)