Sample code for 30+ languages & platforms
Xojo Plugin

Capture the Composed REST Request for Debugging

See more REST Examples

Demonstrates Rest.GetLastDebugRequest, which copies the fully composed HTTP request (request line, headers, and body) into a BinData. The example builds a two-part multipart request so the captured output shows the multipart boundaries, part headers, and part bodies. This works when the DebugMode property was enabled while the request was composed.

Background. When DebugMode is enabled, Chilkat builds the request but does not transmit it, so GetLastDebugRequest can reveal the exact bytes that would be sent. Inspecting the composed request is valuable for diagnosing API problems.

Chilkat Xojo Plugin Downloads

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

//  Enable debug mode so the fully composed HTTP request is captured instead of being sent.
rest.DebugMode = True

//  Build a multipart request with two parts.  The captured debug output will show the multipart
//  boundaries, part headers, and part bodies.
rest.PartSelector = "1"
success = rest.AddHeader("Content-Type","text/plain")
success = rest.AddHeader("Content-Disposition","form-data; name=""field1""")
success = rest.SetMultipartBodyString("value1")
If (success = False) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

rest.PartSelector = "2"
success = rest.AddHeader("Content-Type","application/json")
success = rest.AddHeader("Content-Disposition","form-data; name=""metadata""")
success = rest.SetMultipartBodyString("{ ""active"": true }")
If (success = False) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

//  Compose the multipart request.  In debug mode the request is built but not transmitted.
success = rest.SendReqMultipart("POST","/api/upload")
If (success = False) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

//  Copy the composed request (request line, headers, and multipart body that would be sent) into a
//  BinData, then view it as text.
Dim bdRequest As New Chilkat.BinData
success = rest.GetLastDebugRequest(bdRequest)

Dim requestText As String
requestText = bdRequest.GetString("utf-8")
If (bdRequest.LastMethodSuccess = False) Then
    System.DebugLog(bdRequest.LastErrorText)
    Return
End If

System.DebugLog(requestText)