Unicode C

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.

Unicode C

#include <C_CkRestW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkBinDataW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkRestW rest;
    BOOL bTls;
    int port;
    BOOL bAutoReconnect;
    HCkJsonObjectW json;
    HCkStringBuilderW sbRequestBody;
    HCkStringBuilderW sbResponseBody;
    HCkBinDataW bdRequest;

    success = 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.

    rest = CkRestW_Create();

    // Connect Code...
    // URL: https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/returns
    bTls = TRUE;
    port = 443;
    bAutoReconnect = TRUE;
    success = CkRestW_Connect(rest,L"test-api.service.hmrc.gov.uk",port,bTls,bAutoReconnect);
    if (success != TRUE) {
        wprintf(L"ConnectFailReason: %d\n",CkRestW_getConnectFailReason(rest));
        wprintf(L"%s\n",CkRestW_lastErrorText(rest));
        CkRestW_Dispose(rest);
        return;
    }

    // Build the request body...
    json = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(json,L"periodKey",L"A001");
    CkJsonObjectW_UpdateNumber(json,L"vatDueSales",L"105.50");
    CkJsonObjectW_UpdateNumber(json,L"vatDueAcquisitions",L"-100.45");
    CkJsonObjectW_UpdateNumber(json,L"totalVatDue",L"5.05");
    CkJsonObjectW_UpdateNumber(json,L"vatReclaimedCurrPeriod",L"105.15");
    CkJsonObjectW_UpdateNumber(json,L"netVatDue",L"100.10");
    CkJsonObjectW_UpdateInt(json,L"totalValueSalesExVAT",300);
    CkJsonObjectW_UpdateInt(json,L"totalValuePurchasesExVAT",300);
    CkJsonObjectW_UpdateInt(json,L"totalValueGoodsSuppliedExVAT",3000);
    CkJsonObjectW_UpdateInt(json,L"totalAcquisitionsExVAT",3000);
    CkJsonObjectW_UpdateBool(json,L"finalised",TRUE);

    // Add Headers...
    CkRestW_AddHeader(rest,L"Accept",L"application/vnd.hmrc.1.0+json");
    CkRestW_AddHeader(rest,L"Authorization",L"Bearer HMRC_ACCESS_TOKEN");
    CkRestW_AddHeader(rest,L"Content-Type",L"application/json");

    sbRequestBody = CkStringBuilderW_Create();
    CkJsonObjectW_EmitSb(json,sbRequestBody);

    // Set DebugMode so that no request is actually sent.
    CkRestW_putDebugMode(rest,TRUE);

    sbResponseBody = CkStringBuilderW_Create();
    success = CkRestW_FullRequestSb(rest,L"POST",L"/organisations/vat/MY_HMRC_VRN/returns",sbRequestBody,sbResponseBody);
    if (success != TRUE) {
        wprintf(L"%s\n",CkRestW_lastErrorText(rest));
        CkRestW_Dispose(rest);
        CkJsonObjectW_Dispose(json);
        CkStringBuilderW_Dispose(sbRequestBody);
        CkStringBuilderW_Dispose(sbResponseBody);
        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..
    bdRequest = CkBinDataW_Create();
    success = CkRestW_GetLastDebugRequest(rest,bdRequest);

    wprintf(L"----\n");
    wprintf(L"%s\n",CkBinDataW_getString(bdRequest,L"utf-8"));
    wprintf(L"----\n");

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


    CkRestW_Dispose(rest);
    CkJsonObjectW_Dispose(json);
    CkStringBuilderW_Dispose(sbRequestBody);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkBinDataW_Dispose(bdRequest);

    }