Swift

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.

Swift

func chilkatTest() {
    var success: Bool = false

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

    let rest = CkoRest()!

    // Connect Code...
    // URL: https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/returns
    var bTls: Bool = true
    var port: Int = 443
    var bAutoReconnect: Bool = true
    success = rest.connect(hostname: "test-api.service.hmrc.gov.uk", port: port, tls: bTls, autoReconnect: bAutoReconnect)
    if success != true {
        print("ConnectFailReason: \(rest.connectFailReason.intValue)")
        print("\(rest.lastErrorText!)")
        return
    }

    // Build the request body...
    let json = CkoJsonObject()!
    json.updateString(jsonPath: "periodKey", value: "A001")
    json.updateNumber(jsonPath: "vatDueSales", numericStr: "105.50")
    json.updateNumber(jsonPath: "vatDueAcquisitions", numericStr: "-100.45")
    json.updateNumber(jsonPath: "totalVatDue", numericStr: "5.05")
    json.updateNumber(jsonPath: "vatReclaimedCurrPeriod", numericStr: "105.15")
    json.updateNumber(jsonPath: "netVatDue", numericStr: "100.10")
    json.updateInt(jsonPath: "totalValueSalesExVAT", value: 300)
    json.updateInt(jsonPath: "totalValuePurchasesExVAT", value: 300)
    json.updateInt(jsonPath: "totalValueGoodsSuppliedExVAT", value: 3000)
    json.updateInt(jsonPath: "totalAcquisitionsExVAT", value: 3000)
    json.updateBool(jsonPath: "finalised", value: true)

    // Add Headers...
    rest.addHeader(name: "Accept", value: "application/vnd.hmrc.1.0+json")
    rest.addHeader(name: "Authorization", value: "Bearer HMRC_ACCESS_TOKEN")
    rest.addHeader(name: "Content-Type", value: "application/json")

    let sbRequestBody = CkoStringBuilder()!
    json.emitSb(sb: sbRequestBody)

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

    let sbResponseBody = CkoStringBuilder()!
    success = rest.fullRequestSb(httpVerb: "POST", uriPath: "/organisations/vat/MY_HMRC_VRN/returns", requestBody: sbRequestBody, responseBody: sbResponseBody)
    if success != true {
        print("\(rest.lastErrorText!)")
        return
    }

    // 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..
    let bdRequest = CkoBinData()!
    success = rest.getLastDebugRequest(bd: bdRequest)

    print("----")
    print("\(bdRequest.getString(charset: "utf-8")!)")
    print("----")

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

}