Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *Accountid;
BOOL Active;
int Auto_bill;
const char *Billing_status;
const char *Bus_phone;
const char *Business_type;
const char *Business_uuid;
const char *City;
const char *Code;
const char *Country;
const char *Currency_code;
const char *Date;
const char *Discountid;
BOOL Dst;
int Duration;
const char *v_Email;
const char *Fax;
const char *Amount;
const char *Gst_amountCode;
const char *Heard_about_us_via;
int Id;
const char *Info_email;
const char *Ip;
const char *Landing_url;
BOOL Masterlock_billing;
const char *Migrated_to_smux_at;
const char *Mob_phone;
BOOL Modern_system;
const char *Name;
const char *Num_clients;
const char *Num_staff;
const char *Payment_amountAmount;
const char *Payment_amountCode;
int Payment_frequency;
const char *Province;
const char *Referralid;
const char *Referring_url;
const char *Salutation;
const char *Size_limit;
const char *Split_token;
const char *Street;
const char *Street2;
int Systemid;
BOOL Test_system;
const char *Timezone;
int Timezoneid;
const char *Vat_name;
const char *Vat_number;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,"<access_token>");
CkHttp_SetRequestHeader(http,"Content-Type","application/json");
sbResponseBody = CkStringBuilder_Create();
success = CkHttp_QuickGetSb(http,"https://api.freshbooks.com/accounting/account/{{accountId}}/systems/systems/{{businessId}}",sbResponseBody);
if (success == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttp_getLastStatus(http);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttp_lastHeader(http));
printf("Failed.\n");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "response": {
// "result": {
// "system": {
// "accountid": "wkMd2g",
// "active": true,
// "auto_bill": 5,
// "billing_status": "uptodate",
// "bus_phone": "",
// "business_type": null,
// "business_uuid": null,
// "city": "",
// "code": "",
// "country": "Canada",
// "currency_code": "USD",
// "date": "2019-04-18 09:14:53",
// "discountid": null,
// "dst": true,
// "duration": 12,
// "email": "api.freshbooks@gmail.com",
// "fax": "",
// "gst_amount": {
// "amount": "0.00",
// "code": "USD"
// },
// "heard_about_us_via": null,
// "id": 4236410,
// "info_email": "api.freshbooks@gmail.com",
// "ip": "62.205.194.4",
// "landing_url": null,
// "masterlock_billing": true,
// "migrated_to_smux_at": null,
// "mob_phone": "",
// "modern_system": true,
// "name": "Postman Sandbox",
// "num_clients": null,
// "num_staff": null,
// "payment_amount": {
// "amount": "0.00",
// "code": "USD"
// },
// "payment_frequency": 1,
// "province": "",
// "referralid": "multibiz",
// "referring_url": null,
// "salutation": null,
// "size_limit": null,
// "split_token": null,
// "street": "",
// "street2": null,
// "systemid": 4236410,
// "test_system": false,
// "timezone": "UTC",
// "timezoneid": 14,
// "vat_name": null,
// "vat_number": null
// }
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
Accountid = CkJsonObject_stringOf(jResp,"response.result.system.accountid");
Active = CkJsonObject_BoolOf(jResp,"response.result.system.active");
Auto_bill = CkJsonObject_IntOf(jResp,"response.result.system.auto_bill");
Billing_status = CkJsonObject_stringOf(jResp,"response.result.system.billing_status");
Bus_phone = CkJsonObject_stringOf(jResp,"response.result.system.bus_phone");
Business_type = CkJsonObject_stringOf(jResp,"response.result.system.business_type");
Business_uuid = CkJsonObject_stringOf(jResp,"response.result.system.business_uuid");
City = CkJsonObject_stringOf(jResp,"response.result.system.city");
Code = CkJsonObject_stringOf(jResp,"response.result.system.code");
Country = CkJsonObject_stringOf(jResp,"response.result.system.country");
Currency_code = CkJsonObject_stringOf(jResp,"response.result.system.currency_code");
Date = CkJsonObject_stringOf(jResp,"response.result.system.date");
Discountid = CkJsonObject_stringOf(jResp,"response.result.system.discountid");
Dst = CkJsonObject_BoolOf(jResp,"response.result.system.dst");
Duration = CkJsonObject_IntOf(jResp,"response.result.system.duration");
v_Email = CkJsonObject_stringOf(jResp,"response.result.system.email");
Fax = CkJsonObject_stringOf(jResp,"response.result.system.fax");
Amount = CkJsonObject_stringOf(jResp,"response.result.system.gst_amount.amount");
Gst_amountCode = CkJsonObject_stringOf(jResp,"response.result.system.gst_amount.code");
Heard_about_us_via = CkJsonObject_stringOf(jResp,"response.result.system.heard_about_us_via");
Id = CkJsonObject_IntOf(jResp,"response.result.system.id");
Info_email = CkJsonObject_stringOf(jResp,"response.result.system.info_email");
Ip = CkJsonObject_stringOf(jResp,"response.result.system.ip");
Landing_url = CkJsonObject_stringOf(jResp,"response.result.system.landing_url");
Masterlock_billing = CkJsonObject_BoolOf(jResp,"response.result.system.masterlock_billing");
Migrated_to_smux_at = CkJsonObject_stringOf(jResp,"response.result.system.migrated_to_smux_at");
Mob_phone = CkJsonObject_stringOf(jResp,"response.result.system.mob_phone");
Modern_system = CkJsonObject_BoolOf(jResp,"response.result.system.modern_system");
Name = CkJsonObject_stringOf(jResp,"response.result.system.name");
Num_clients = CkJsonObject_stringOf(jResp,"response.result.system.num_clients");
Num_staff = CkJsonObject_stringOf(jResp,"response.result.system.num_staff");
Payment_amountAmount = CkJsonObject_stringOf(jResp,"response.result.system.payment_amount.amount");
Payment_amountCode = CkJsonObject_stringOf(jResp,"response.result.system.payment_amount.code");
Payment_frequency = CkJsonObject_IntOf(jResp,"response.result.system.payment_frequency");
Province = CkJsonObject_stringOf(jResp,"response.result.system.province");
Referralid = CkJsonObject_stringOf(jResp,"response.result.system.referralid");
Referring_url = CkJsonObject_stringOf(jResp,"response.result.system.referring_url");
Salutation = CkJsonObject_stringOf(jResp,"response.result.system.salutation");
Size_limit = CkJsonObject_stringOf(jResp,"response.result.system.size_limit");
Split_token = CkJsonObject_stringOf(jResp,"response.result.system.split_token");
Street = CkJsonObject_stringOf(jResp,"response.result.system.street");
Street2 = CkJsonObject_stringOf(jResp,"response.result.system.street2");
Systemid = CkJsonObject_IntOf(jResp,"response.result.system.systemid");
Test_system = CkJsonObject_BoolOf(jResp,"response.result.system.test_system");
Timezone = CkJsonObject_stringOf(jResp,"response.result.system.timezone");
Timezoneid = CkJsonObject_IntOf(jResp,"response.result.system.timezoneid");
Vat_name = CkJsonObject_stringOf(jResp,"response.result.system.vat_name");
Vat_number = CkJsonObject_stringOf(jResp,"response.result.system.vat_number");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://api.freshbooks.com/accounting/account/{{accountId}}/systems/systems/{{businessId}}
Postman Collection Item JSON
{
"name": "Get System ",
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/systems/systems/{{businessId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"systems",
"systems",
"{{businessId}}"
]
},
"description": "The value of `<id>` here is only meaningful if a user has access to multiple systems. See the Identity Model for more information."
},
"response": [
{
"name": "Get System ",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/systems/systems/{{businessId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"systems",
"systems",
"{{businessId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gXSEVHBwsQWEMbSxZdVRYeA0kJTwFZC1VXAgRZXlANAgRQUVYEHRpXSBNUVlBfBwAFAQlUDw8GVwFUG01XAF8RAWs="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:38:32 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Age",
"value": "0"
},
{
"key": "Age",
"value": "0"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 18:38:32 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17369-MDW"
},
{
"key": "X-Cache",
"value": "MISS"
},
{
"key": "X-Cache-Hits",
"value": "0"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"response\": {\n \"result\": {\n \"system\": {\n \"accountid\": \"wkMd2g\",\n \"active\": true,\n \"auto_bill\": 5,\n \"billing_status\": \"uptodate\",\n \"bus_phone\": \"\",\n \"business_type\": null,\n \"business_uuid\": null,\n \"city\": \"\",\n \"code\": \"\",\n \"country\": \"Canada\",\n \"currency_code\": \"USD\",\n \"date\": \"2019-04-18 09:14:53\",\n \"discountid\": null,\n \"dst\": true,\n \"duration\": 12,\n \"email\": \"api.freshbooks@gmail.com\",\n \"fax\": \"\",\n \"gst_amount\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"heard_about_us_via\": null,\n \"id\": 4236410,\n \"info_email\": \"api.freshbooks@gmail.com\",\n \"ip\": \"62.205.194.4\",\n \"landing_url\": null,\n \"masterlock_billing\": true,\n \"migrated_to_smux_at\": null,\n \"mob_phone\": \"\",\n \"modern_system\": true,\n \"name\": \"Postman Sandbox\",\n \"num_clients\": null,\n \"num_staff\": null,\n \"payment_amount\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"payment_frequency\": 1,\n \"province\": \"\",\n \"referralid\": \"multibiz\",\n \"referring_url\": null,\n \"salutation\": null,\n \"size_limit\": null,\n \"split_token\": null,\n \"street\": \"\",\n \"street2\": null,\n \"systemid\": 4236410,\n \"test_system\": false,\n \"timezone\": \"UTC\",\n \"timezoneid\": 14,\n \"vat_name\": null,\n \"vat_number\": null\n }\n }\n }\n}"
}
]
}
