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 *name;
BOOL value;
int i;
int count_i;
// 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>");
sbResponseBody = CkStringBuilder_Create();
success = CkHttp_QuickGetSb(http,"https://api.freshbooks.com/projects/business/{{businessId}}/abilities",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)
// {
// "abilities": [
// {
// "name": "can_view_projects",
// "value": true
// },
// {
// "name": "can_create_projects",
// "value": true
// },
// {
// "name": "can_create_services",
// "value": true
// },
// {
// "name": "can_view_services",
// "value": true
// },
// {
// "name": "can_view_time_entries",
// "value": true
// },
// {
// "name": "can_create_time_entries",
// "value": true
// },
// {
// "name": "can_mark_time_entries_billed",
// "value": true
// },
// {
// "name": "can_view_team_time_entries",
// "value": true
// },
// {
// "name": "can_view_time_tracking_settings",
// "value": true
// }
// ]
// }
// 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.
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"abilities");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
name = CkJsonObject_stringOf(jResp,"abilities[i].name");
value = CkJsonObject_BoolOf(jResp,"abilities[i].value");
i = i + 1;
}
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.freshbooks.com/projects/business/{{businessId}}/abilities
Postman Collection Item JSON
{
"name": "Abilities",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/projects/business/{{businessId}}/abilities",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"projects",
"business",
"{{businessId}}",
"abilities"
]
}
},
"response": [
{
"name": "Abilities",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/projects/business/{{businessId}}/abilities",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"projects",
"business",
"{{businessId}}",
"abilities"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "X-Version",
"value": "1904.22.0"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNA1ILVAtMUVFBHRdcEl4UQQEBDFYDDw9RR1kBEhBSQlgTFlJTEU5WT1IeUg1TCw4FBwVVAVMAVABRVhoaUEpBWwYBAlJbUwIDVVxUAAJUVkFOVgNUEV1l"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Mon, 23 Apr 2018 17:47:51 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"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": "Content-Length",
"value": "477"
},
{
"key": "Date",
"value": "Tue, 23 Apr 2019 17:47:51 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17335-MDW"
},
{
"key": "X-Cache",
"value": "MISS"
},
{
"key": "X-Cache-Hits",
"value": "0"
},
{
"key": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"abilities\": [\n {\n \"name\": \"can_view_projects\",\n \"value\": true\n },\n {\n \"name\": \"can_create_projects\",\n \"value\": true\n },\n {\n \"name\": \"can_create_services\",\n \"value\": true\n },\n {\n \"name\": \"can_view_services\",\n \"value\": true\n },\n {\n \"name\": \"can_view_time_entries\",\n \"value\": true\n },\n {\n \"name\": \"can_create_time_entries\",\n \"value\": true\n },\n {\n \"name\": \"can_mark_time_entries_billed\",\n \"value\": true\n },\n {\n \"name\": \"can_view_team_time_entries\",\n \"value\": true\n },\n {\n \"name\": \"can_view_time_tracking_settings\",\n \"value\": true\n }\n ]\n}"
}
]
}
