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

Objective-C

#import <CkoRest.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoBinData.h>

BOOL success = NO;

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

CkoRest *rest = [[CkoRest alloc] init];

//  Connect Code...
//  URL: https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/returns
BOOL bTls = YES;
int port = 443;
BOOL bAutoReconnect = YES;
success = [rest Connect: @"test-api.service.hmrc.gov.uk" port: [NSNumber numberWithInt: port] tls: bTls autoReconnect: bAutoReconnect];
if (success != YES) {
    NSLog(@"%@%d",@"ConnectFailReason: ",[rest.ConnectFailReason intValue]);
    NSLog(@"%@",rest.LastErrorText);
    return;
}

//  Build the request body...
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"periodKey" value: @"A001"];
[json UpdateNumber: @"vatDueSales" numericStr: @"105.50"];
[json UpdateNumber: @"vatDueAcquisitions" numericStr: @"-100.45"];
[json UpdateNumber: @"totalVatDue" numericStr: @"5.05"];
[json UpdateNumber: @"vatReclaimedCurrPeriod" numericStr: @"105.15"];
[json UpdateNumber: @"netVatDue" numericStr: @"100.10"];
[json UpdateInt: @"totalValueSalesExVAT" value: [NSNumber numberWithInt: 300]];
[json UpdateInt: @"totalValuePurchasesExVAT" value: [NSNumber numberWithInt: 300]];
[json UpdateInt: @"totalValueGoodsSuppliedExVAT" value: [NSNumber numberWithInt: 3000]];
[json UpdateInt: @"totalAcquisitionsExVAT" value: [NSNumber numberWithInt: 3000]];
[json UpdateBool: @"finalised" value: YES];

//  Add Headers...
[rest AddHeader: @"Accept" value: @"application/vnd.hmrc.1.0+json"];
[rest AddHeader: @"Authorization" value: @"Bearer HMRC_ACCESS_TOKEN"];
[rest AddHeader: @"Content-Type" value: @"application/json"];

CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[json EmitSb: sbRequestBody];

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

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [rest FullRequestSb: @"POST" uriPath: @"/organisations/vat/MY_HMRC_VRN/returns" requestBody: sbRequestBody responseBody: sbResponseBody];
if (success != YES) {
    NSLog(@"%@",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..
CkoBinData *bdRequest = [[CkoBinData alloc] init];
success = [rest GetLastDebugRequest: bdRequest];

NSLog(@"%@",@"----");
NSLog(@"%@",[bdRequest GetString: @"utf-8"]);
NSLog(@"%@",@"----");

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