Chilkat Online Tools

C / New FreshBooks / List Projects

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;
    int id;
    const char *title;
    const char *description;
    const char *due_date;
    int client_id;
    BOOL internal;
    const char *budget;
    const char *fixed_price;
    const char *rate;
    const char *billing_method;
    const char *project_type;
    BOOL active;
    BOOL complete;
    BOOL sample;
    const char *created_at;
    const char *updated_at;
    const char *logged_duration;
    const char *billed_amount;
    const char *billed_status;
    int group_id;
    int j;
    int count_j;
    int business_id;
    const char *name;
    BOOL billable;
    int vis_state;
    int Total;
    int Per_page;
    int Page;
    int Pages;
    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}}/projects",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)

    // {
    //   "meta": {
    //     "sort": [
    //     ],
    //     "total": 5,
    //     "per_page": 30,
    //     "page": 1,
    //     "pages": 1
    //   },
    //   "projects": [
    //     {
    //       "id": 2980878,
    //       "title": "K2 Hiking Guide",
    //       "description": null,
    //       "due_date": "2019-04-20",
    //       "client_id": 31006,
    //       "internal": false,
    //       "budget": null,
    //       "fixed_price": "2000.00",
    //       "rate": null,
    //       "billing_method": null,
    //       "project_type": "fixed_price",
    //       "active": true,
    //       "complete": false,
    //       "sample": false,
    //       "created_at": "2019-04-19T18:25:00",
    //       "updated_at": "2019-04-19T19:50:26",
    //       "logged_duration": null,
    //       "services": [
    //       ],
    //       "billed_amount": "0.00",
    //       "billed_status": "unbilled",
    //       "group_id": 4951020
    //     },
    //     {
    //       "id": 2980874,
    //       "title": "Applachian Hiking Guide",
    //       "description": null,
    //       "due_date": "2019-05-20",
    //       "client_id": 31006,
    //       "internal": false,
    //       "budget": null,
    //       "fixed_price": "1000.00",
    //       "rate": null,
    //       "billing_method": null,
    //       "project_type": "fixed_price",
    //       "active": true,
    //       "complete": false,
    //       "sample": false,
    //       "created_at": "2019-04-19T18:22:43",
    //       "updated_at": "2019-04-19T18:22:43",
    //       "logged_duration": null,
    //       "services": [
    //       ],
    //       "billed_amount": "0.00",
    //       "billed_status": "unbilled",
    //       "group_id": 4951012
    //     },
    //     {
    //       "id": 2980872,
    //       "title": "Applachian Hiking Guide",
    //       "description": null,
    //       "due_date": "2019-05-20",
    //       "client_id": 31006,
    //       "internal": false,
    //       "budget": null,
    //       "fixed_price": "1000.00",
    //       "rate": null,
    //       "billing_method": null,
    //       "project_type": "fixed_price",
    //       "active": true,
    //       "complete": false,
    //       "sample": false,
    //       "created_at": "2019-04-19T18:22:06",
    //       "updated_at": "2019-04-19T18:22:06",
    //       "logged_duration": null,
    //       "services": [
    //       ],
    //       "billed_amount": "0.00",
    //       "billed_status": "unbilled",
    //       "group_id": 4951006
    //     },
    //     {
    //       "id": 2980870,
    //       "title": "Hiking Guide",
    //       "description": null,
    //       "due_date": "2019-05-20",
    //       "client_id": 31006,
    //       "internal": false,
    //       "budget": null,
    //       "fixed_price": "500.00",
    //       "rate": null,
    //       "billing_method": null,
    //       "project_type": "fixed_price",
    //       "active": true,
    //       "complete": false,
    //       "sample": false,
    //       "created_at": "2019-04-19T18:21:11",
    //       "updated_at": "2019-04-19T18:21:11",
    //       "logged_duration": null,
    //       "services": [
    //       ],
    //       "billed_amount": "0.00",
    //       "billed_status": "unbilled",
    //       "group_id": 4951004
    //     },
    //     {
    //       "id": 2976412,
    //       "title": "Very Custom Computer thing",
    //       "description": null,
    //       "due_date": null,
    //       "client_id": 31006,
    //       "internal": false,
    //       "budget": null,
    //       "fixed_price": null,
    //       "rate": null,
    //       "billing_method": "project_rate",
    //       "project_type": "fixed_price",
    //       "active": true,
    //       "complete": false,
    //       "sample": false,
    //       "created_at": "2019-04-18T13:43:31",
    //       "updated_at": "2019-04-18T13:43:31",
    //       "logged_duration": null,
    //       "services": [
    //         {
    //           "business_id": 1966214,
    //           "id": 3575792,
    //           "name": "Computer Hardware",
    //           "billable": true,
    //           "vis_state": 0
    //         }
    //       ],
    //       "billed_amount": "0.00",
    //       "billed_status": "unbilled",
    //       "group_id": 4942784
    //     }
    //   ]
    // }

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

    Total = CkJsonObject_IntOf(jResp,"meta.total");
    Per_page = CkJsonObject_IntOf(jResp,"meta.per_page");
    Page = CkJsonObject_IntOf(jResp,"meta.page");
    Pages = CkJsonObject_IntOf(jResp,"meta.pages");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"meta.sort");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"projects");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        id = CkJsonObject_IntOf(jResp,"projects[i].id");
        title = CkJsonObject_stringOf(jResp,"projects[i].title");
        description = CkJsonObject_stringOf(jResp,"projects[i].description");
        due_date = CkJsonObject_stringOf(jResp,"projects[i].due_date");
        client_id = CkJsonObject_IntOf(jResp,"projects[i].client_id");
        internal = CkJsonObject_BoolOf(jResp,"projects[i].internal");
        budget = CkJsonObject_stringOf(jResp,"projects[i].budget");
        fixed_price = CkJsonObject_stringOf(jResp,"projects[i].fixed_price");
        rate = CkJsonObject_stringOf(jResp,"projects[i].rate");
        billing_method = CkJsonObject_stringOf(jResp,"projects[i].billing_method");
        project_type = CkJsonObject_stringOf(jResp,"projects[i].project_type");
        active = CkJsonObject_BoolOf(jResp,"projects[i].active");
        complete = CkJsonObject_BoolOf(jResp,"projects[i].complete");
        sample = CkJsonObject_BoolOf(jResp,"projects[i].sample");
        created_at = CkJsonObject_stringOf(jResp,"projects[i].created_at");
        updated_at = CkJsonObject_stringOf(jResp,"projects[i].updated_at");
        logged_duration = CkJsonObject_stringOf(jResp,"projects[i].logged_duration");
        billed_amount = CkJsonObject_stringOf(jResp,"projects[i].billed_amount");
        billed_status = CkJsonObject_stringOf(jResp,"projects[i].billed_status");
        group_id = CkJsonObject_IntOf(jResp,"projects[i].group_id");
        j = 0;
        count_j = CkJsonObject_SizeOfArray(jResp,"projects[i].services");
        while (j < count_j) {
            CkJsonObject_putJ(jResp,j);
            business_id = CkJsonObject_IntOf(jResp,"projects[i].services[j].business_id");
            id = CkJsonObject_IntOf(jResp,"projects[i].services[j].id");
            name = CkJsonObject_stringOf(jResp,"projects[i].services[j].name");
            billable = CkJsonObject_BoolOf(jResp,"projects[i].services[j].billable");
            vis_state = CkJsonObject_IntOf(jResp,"projects[i].services[j].vis_state");
            j = j + 1;
        }

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

Postman Collection Item JSON

{
  "name": "List Projects",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "let jsonData = JSON.parse(responseBody);",
          "pm.environment.set(\"projectId\", jsonData.projects[0].id);"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.freshbooks.com/projects/business/{{businessId}}/projects",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "projects",
        "business",
        "{{businessId}}",
        "projects"
      ]
    },
    "description": "Remember to remove `Content-Type` headers when making a GET call on projects and time-tracking."
  },
  "response": [
    {
      "name": "List Projects",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.freshbooks.com/projects/business/{{businessId}}/projects",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "projects",
            "business",
            "{{businessId}}",
            "projects"
          ]
        }
      },
      "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.24.0"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNEkINUgdbTEccQQBKDkQTUAdeRkUODAZbR0NGTVIbARlWUgYBA1FfVVADUA5SDAEMHh5UFUMAVVdUUA9VWAUCD1IIUlhQFR1RBwhCU24="
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:24:44 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": "2629"
        },
        {
          "key": "Date",
          "value": "Wed, 24 Apr 2019 18:24:44 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": "Country",
          "value": "CA"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536000; includeSubDomains; preload"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"meta\": {\n        \"sort\": [],\n        \"total\": 5,\n        \"per_page\": 30,\n        \"page\": 1,\n        \"pages\": 1\n    },\n    \"projects\": [\n        {\n            \"id\": 2980878,\n            \"title\": \"K2 Hiking Guide\",\n            \"description\": null,\n            \"due_date\": \"2019-04-20\",\n            \"client_id\": 31006,\n            \"internal\": false,\n            \"budget\": null,\n            \"fixed_price\": \"2000.00\",\n            \"rate\": null,\n            \"billing_method\": null,\n            \"project_type\": \"fixed_price\",\n            \"active\": true,\n            \"complete\": false,\n            \"sample\": false,\n            \"created_at\": \"2019-04-19T18:25:00\",\n            \"updated_at\": \"2019-04-19T19:50:26\",\n            \"logged_duration\": null,\n            \"services\": [],\n            \"billed_amount\": \"0.00\",\n            \"billed_status\": \"unbilled\",\n            \"group_id\": 4951020\n        },\n        {\n            \"id\": 2980874,\n            \"title\": \"Applachian Hiking Guide\",\n            \"description\": null,\n            \"due_date\": \"2019-05-20\",\n            \"client_id\": 31006,\n            \"internal\": false,\n            \"budget\": null,\n            \"fixed_price\": \"1000.00\",\n            \"rate\": null,\n            \"billing_method\": null,\n            \"project_type\": \"fixed_price\",\n            \"active\": true,\n            \"complete\": false,\n            \"sample\": false,\n            \"created_at\": \"2019-04-19T18:22:43\",\n            \"updated_at\": \"2019-04-19T18:22:43\",\n            \"logged_duration\": null,\n            \"services\": [],\n            \"billed_amount\": \"0.00\",\n            \"billed_status\": \"unbilled\",\n            \"group_id\": 4951012\n        },\n        {\n            \"id\": 2980872,\n            \"title\": \"Applachian Hiking Guide\",\n            \"description\": null,\n            \"due_date\": \"2019-05-20\",\n            \"client_id\": 31006,\n            \"internal\": false,\n            \"budget\": null,\n            \"fixed_price\": \"1000.00\",\n            \"rate\": null,\n            \"billing_method\": null,\n            \"project_type\": \"fixed_price\",\n            \"active\": true,\n            \"complete\": false,\n            \"sample\": false,\n            \"created_at\": \"2019-04-19T18:22:06\",\n            \"updated_at\": \"2019-04-19T18:22:06\",\n            \"logged_duration\": null,\n            \"services\": [],\n            \"billed_amount\": \"0.00\",\n            \"billed_status\": \"unbilled\",\n            \"group_id\": 4951006\n        },\n        {\n            \"id\": 2980870,\n            \"title\": \"Hiking Guide\",\n            \"description\": null,\n            \"due_date\": \"2019-05-20\",\n            \"client_id\": 31006,\n            \"internal\": false,\n            \"budget\": null,\n            \"fixed_price\": \"500.00\",\n            \"rate\": null,\n            \"billing_method\": null,\n            \"project_type\": \"fixed_price\",\n            \"active\": true,\n            \"complete\": false,\n            \"sample\": false,\n            \"created_at\": \"2019-04-19T18:21:11\",\n            \"updated_at\": \"2019-04-19T18:21:11\",\n            \"logged_duration\": null,\n            \"services\": [],\n            \"billed_amount\": \"0.00\",\n            \"billed_status\": \"unbilled\",\n            \"group_id\": 4951004\n        },\n        {\n            \"id\": 2976412,\n            \"title\": \"Very Custom Computer thing\",\n            \"description\": null,\n            \"due_date\": null,\n            \"client_id\": 31006,\n            \"internal\": false,\n            \"budget\": null,\n            \"fixed_price\": null,\n            \"rate\": null,\n            \"billing_method\": \"project_rate\",\n            \"project_type\": \"fixed_price\",\n            \"active\": true,\n            \"complete\": false,\n            \"sample\": false,\n            \"created_at\": \"2019-04-18T13:43:31\",\n            \"updated_at\": \"2019-04-18T13:43:31\",\n            \"logged_duration\": null,\n            \"services\": [\n                {\n                    \"business_id\": 1966214,\n                    \"id\": 3575792,\n                    \"name\": \"Computer Hardware\",\n                    \"billable\": true,\n                    \"vis_state\": 0\n                }\n            ],\n            \"billed_amount\": \"0.00\",\n            \"billed_status\": \"unbilled\",\n            \"group_id\": 4942784\n        }\n    ]\n}"
    }
  ]
}