Chilkat Online Tools

C / New FreshBooks / Get all retainers

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;
    int business_id;
    int system_id;
    const char *invoice_profile_id;
    int client_user_id;
    const char *start_date;
    const char *next_period_start_date;
    const char *fee;
    const char *excess_rate;
    int budgeted_time;
    BOOL active;
    const char *created_at;
    const char *updated_at;
    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/comments/business/{{businessId}}/retainers",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)

    // {
    //   "retainers": [
    //     {
    //       "id": 2248,
    //       "business_id": 1966214,
    //       "system_id": 4236410,
    //       "invoice_profile_id": null,
    //       "client_user_id": 32046,
    //       "start_date": "2019-06-03",
    //       "next_period_start_date": "2019-06-03",
    //       "fee": "500.00",
    //       "excess_rate": "100.00",
    //       "budgeted_time": 144000,
    //       "active": true,
    //       "created_at": "2019-06-03T15:42:49",
    //       "updated_at": "2019-06-03T15:42:49"
    //     },
    //     {
    //       "id": 2272,
    //       "business_id": 1966214,
    //       "system_id": 4236410,
    //       "invoice_profile_id": null,
    //       "client_user_id": 75162,
    //       "start_date": "2019-06-03",
    //       "next_period_start_date": "2019-06-03",
    //       "fee": "20.00",
    //       "excess_rate": "500.00",
    //       "budgeted_time": 180000,
    //       "active": true,
    //       "created_at": "2019-06-03T18:08:30",
    //       "updated_at": "2019-06-03T18:08:30"
    //     },
    //     {
    //       "id": 2274,
    //       "business_id": 1966214,
    //       "system_id": 4236410,
    //       "invoice_profile_id": null,
    //       "client_user_id": 32040,
    //       "start_date": "2019-06-05",
    //       "next_period_start_date": "2019-06-03",
    //       "fee": "600.00",
    //       "excess_rate": "200.00",
    //       "budgeted_time": 144000,
    //       "active": true,
    //       "created_at": "2019-06-03T18:11:26",
    //       "updated_at": "2019-06-03T18:11:26"
    //     }
    //   ]
    // }

    // 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,"retainers");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        id = CkJsonObject_IntOf(jResp,"retainers[i].id");
        business_id = CkJsonObject_IntOf(jResp,"retainers[i].business_id");
        system_id = CkJsonObject_IntOf(jResp,"retainers[i].system_id");
        invoice_profile_id = CkJsonObject_stringOf(jResp,"retainers[i].invoice_profile_id");
        client_user_id = CkJsonObject_IntOf(jResp,"retainers[i].client_user_id");
        start_date = CkJsonObject_stringOf(jResp,"retainers[i].start_date");
        next_period_start_date = CkJsonObject_stringOf(jResp,"retainers[i].next_period_start_date");
        fee = CkJsonObject_stringOf(jResp,"retainers[i].fee");
        excess_rate = CkJsonObject_stringOf(jResp,"retainers[i].excess_rate");
        budgeted_time = CkJsonObject_IntOf(jResp,"retainers[i].budgeted_time");
        active = CkJsonObject_BoolOf(jResp,"retainers[i].active");
        created_at = CkJsonObject_stringOf(jResp,"retainers[i].created_at");
        updated_at = CkJsonObject_stringOf(jResp,"retainers[i].updated_at");
        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/comments/business/{{businessId}}/retainers

Postman Collection Item JSON

{
  "name": "Get all retainers",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.freshbooks.com/comments/business/{{businessId}}/retainers",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "comments",
        "business",
        "{{businessId}}",
        "retainers"
      ]
    }
  },
  "response": [
    {
      "name": "Get all retainers Success",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.freshbooks.com/comments/business/{{businessId}}/retainers",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "comments",
            "business",
            "{{businessId}}",
            "retainers"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/vnd.api+json"
        },
        {
          "key": "X-Version",
          "value": "1905.33.0"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNEFUWWQtWXUYcQQBKDkQTUAdeRFIVBwpWVkJGTVIbARlXUwYBClRXUVcEUwlbAA8HHh5UFUNSA1YBVQVVUgQFWVdRB1MEFR1RBwhCU24="
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "20"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "0"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1559585847"
        },
        {
          "key": "Retry-After",
          "value": "59"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Sun, 03 Jun 2018 18:16:27 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": "1028"
        },
        {
          "key": "Date",
          "value": "Mon, 03 Jun 2019 18:16:27 GMT"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17376-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    \"retainers\": [\n        {\n            \"id\": 2248,\n            \"business_id\": 1966214,\n            \"system_id\": 4236410,\n            \"invoice_profile_id\": null,\n            \"client_user_id\": 32046,\n            \"start_date\": \"2019-06-03\",\n            \"next_period_start_date\": \"2019-06-03\",\n            \"fee\": \"500.00\",\n            \"excess_rate\": \"100.00\",\n            \"budgeted_time\": 144000,\n            \"active\": true,\n            \"created_at\": \"2019-06-03T15:42:49\",\n            \"updated_at\": \"2019-06-03T15:42:49\"\n        },\n        {\n            \"id\": 2272,\n            \"business_id\": 1966214,\n            \"system_id\": 4236410,\n            \"invoice_profile_id\": null,\n            \"client_user_id\": 75162,\n            \"start_date\": \"2019-06-03\",\n            \"next_period_start_date\": \"2019-06-03\",\n            \"fee\": \"20.00\",\n            \"excess_rate\": \"500.00\",\n            \"budgeted_time\": 180000,\n            \"active\": true,\n            \"created_at\": \"2019-06-03T18:08:30\",\n            \"updated_at\": \"2019-06-03T18:08:30\"\n        },\n        {\n            \"id\": 2274,\n            \"business_id\": 1966214,\n            \"system_id\": 4236410,\n            \"invoice_profile_id\": null,\n            \"client_user_id\": 32040,\n            \"start_date\": \"2019-06-05\",\n            \"next_period_start_date\": \"2019-06-03\",\n            \"fee\": \"600.00\",\n            \"excess_rate\": \"200.00\",\n            \"budgeted_time\": 144000,\n            \"active\": true,\n            \"created_at\": \"2019-06-03T18:11:26\",\n            \"updated_at\": \"2019-06-03T18:11:26\"\n        }\n    ]\n}"
    }
  ]
}