(Xojo Plugin) Debug REST HTTP Request

Demonstrates how to generate the HTTP Request (with all headers intact) without actually sending the request.

Note: This example requires Chilkat v9.5.0.77 or later.

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// This example will connect to the web server, but does not actually send a request.
// When in DebugMode, the request is composed in memory and can be retrieved by calling
// GetLastDebugRequest.

Dim rest As New Chilkat.Rest

// Connect Code...
// URL: https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/returns
Dim bTls As Boolean
bTls = True
Dim port As Int32
port = 443
Dim bAutoReconnect As Boolean
bAutoReconnect = True
Dim success As Boolean
success = rest.Connect("test-api.service.hmrc.gov.uk",port,bTls,bAutoReconnect)
If (success <> True) Then
    System.DebugLog("ConnectFailReason: " + Str(rest.ConnectFailReason))
    System.DebugLog(rest.LastErrorText)
    Return
End If

// Build the request body...
Dim json As New Chilkat.JsonObject
success = json.UpdateString("periodKey","A001")
success = json.UpdateNumber("vatDueSales","105.50")
success = json.UpdateNumber("vatDueAcquisitions","-100.45")
success = json.UpdateNumber("totalVatDue","5.05")
success = json.UpdateNumber("vatReclaimedCurrPeriod","105.15")
success = json.UpdateNumber("netVatDue","100.10")
success = json.UpdateInt("totalValueSalesExVAT",300)
success = json.UpdateInt("totalValuePurchasesExVAT",300)
success = json.UpdateInt("totalValueGoodsSuppliedExVAT",3000)
success = json.UpdateInt("totalAcquisitionsExVAT",3000)
success = json.UpdateBool("finalised",True)

// Add Headers...
success = rest.AddHeader("Accept","application/vnd.hmrc.1.0+json")
success = rest.AddHeader("Authorization","Bearer HMRC_ACCESS_TOKEN")
success = rest.AddHeader("Content-Type","application/json")

Dim sbRequestBody As New Chilkat.StringBuilder
success = json.EmitSb(sbRequestBody)

// Set DebugMode so that no request is actually sent.
rest.DebugMode = True

Dim sbResponseBody As New Chilkat.StringBuilder
success = rest.FullRequestSb("POST","/organisations/vat/MY_HMRC_VRN/returns",sbRequestBody,sbResponseBody)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

// Get the exact contents of what would've been sent.
// This includes the HTTP start line, the HTTP request headers, and the request body.
// Given that it's possible for the request body to contain binary data,
// the GetLastDebugRequest fetches into a BinData object.
// In this case, however, our request body contained JSON, so we can
// examine it as a string..
Dim bdRequest As New Chilkat.BinData
success = rest.GetLastDebugRequest(bdRequest)

System.DebugLog("----")
System.DebugLog(bdRequest.GetString("utf-8"))
System.DebugLog("----")

// The output for the above case:

// POST /organisations/vat/MY_HMRC_VRN/returns HTTP/1.1
// Accept: application/vnd.hmrc.1.0+json
// Host: test-api.service.hmrc.gov.uk
// Authorization: Bearer HMRC_ACCESS_TOKEN
// Content-Type: application/json
// Content-Length: 281
// 
// {"periodKey":"A001","vatDueSales":105.50, ... ,"finalised":true}
// 
//