PowerBuilder

Debug REST HTTP Request

See more REST Examples

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.

PowerBuilder

integer li_rc
long li_Success
oleobject loo_Rest
long li_BTls
long li_Port
long li_BAutoReconnect
oleobject loo_Json
oleobject loo_SbRequestBody
oleobject loo_SbResponseBody
oleobject loo_BdRequest

li_Success = 0

//  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.

loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")
if li_rc < 0 then
    destroy loo_Rest
    MessageBox("Error","Connecting to COM object failed")
    return
end if

//  Connect Code...
//  URL: https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/returns
li_BTls = 1
li_Port = 443
li_BAutoReconnect = 1
li_Success = loo_Rest.Connect("test-api.service.hmrc.gov.uk",li_Port,li_BTls,li_BAutoReconnect)
if li_Success <> 1 then
    Write-Debug "ConnectFailReason: " + string(loo_Rest.ConnectFailReason)
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    return
end if

//  Build the request body...
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.UpdateString("periodKey","A001")
loo_Json.UpdateNumber("vatDueSales","105.50")
loo_Json.UpdateNumber("vatDueAcquisitions","-100.45")
loo_Json.UpdateNumber("totalVatDue","5.05")
loo_Json.UpdateNumber("vatReclaimedCurrPeriod","105.15")
loo_Json.UpdateNumber("netVatDue","100.10")
loo_Json.UpdateInt("totalValueSalesExVAT",300)
loo_Json.UpdateInt("totalValuePurchasesExVAT",300)
loo_Json.UpdateInt("totalValueGoodsSuppliedExVAT",3000)
loo_Json.UpdateInt("totalAcquisitionsExVAT",3000)
loo_Json.UpdateBool("finalised",1)

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

loo_SbRequestBody = create oleobject
li_rc = loo_SbRequestBody.ConnectToNewObject("Chilkat.StringBuilder")

loo_Json.EmitSb(loo_SbRequestBody)

//  Set DebugMode so that no request is actually sent.
loo_Rest.DebugMode = 1

loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

li_Success = loo_Rest.FullRequestSb("POST","/organisations/vat/MY_HMRC_VRN/returns",loo_SbRequestBody,loo_SbResponseBody)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    destroy loo_Json
    destroy loo_SbRequestBody
    destroy loo_SbResponseBody
    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..
loo_BdRequest = create oleobject
li_rc = loo_BdRequest.ConnectToNewObject("Chilkat.BinData")

li_Success = loo_Rest.GetLastDebugRequest(loo_BdRequest)

Write-Debug "----"
Write-Debug loo_BdRequest.GetString("utf-8")
Write-Debug "----"

//  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}
//  
//  


destroy loo_Rest
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_SbResponseBody
destroy loo_BdRequest