Chilkat Online Tools

unicodeC / New FreshBooks / List Staff

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkDtObjW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    HCkDtObjW Date_format;
    int id;
    int group_id;
    const wchar_t *role;
    int identity_id;
    const wchar_t *first_name;
    const wchar_t *last_name;
    const wchar_t *email;
    const wchar_t *company;
    int business_id;
    BOOL unacknowledged_change;
    BOOL active;
    int Id;
    const wchar_t *Name;
    const wchar_t *Account_id;
    int Business_groupId;
    const wchar_t *Category;
    int AddressId;
    const wchar_t *Street;
    const wchar_t *City;
    const wchar_t *Province;
    const wchar_t *Country;
    const wchar_t *Postal_code;
    const wchar_t *Phone_number;
    int i;
    int count_i;

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    http = CkHttpW_Create();

    // Adds the "Authorization: Bearer <access_token>" header.
    CkHttpW_putAuthToken(http,L"<access_token>");
    CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");

    sbResponseBody = CkStringBuilderW_Create();
    success = CkHttpW_QuickGetSb(http,L"https://api.freshbooks.com/auth/api/v1/users/business/{{businessId}}",sbResponseBody);
    if (success == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpW_getLastStatus(http);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpW_lastHeader(http));
        wprintf(L"Failed.\n");
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "response": {
    //     "id": 1966214,
    //     "name": "Postman Sandbox",
    //     "account_id": "wkMd2g",
    //     "business_group": {
    //       "id": 4942664,
    //       "category": "business",
    //       "members": [
    //         {
    //           "id": 6446238,
    //           "group_id": 4942664,
    //           "role": "business_partner",
    //           "identity_id": 37256,
    //           "first_name": "Marshall",
    //           "last_name": "Johnston",
    //           "email": "api.freshbooks@gmail.com",
    //           "company": "Postman Sandbox",
    //           "business_id": 1966214,
    //           "unacknowledged_change": false,
    //           "active": true
    //         },
    //         {
    //           "id": 6475824,
    //           "group_id": 4942664,
    //           "role": "business_accountant",
    //           "identity_id": 75537,
    //           "first_name": "Marshall",
    //           "last_name": "Johnston",
    //           "email": "api.freshbooks@gmail.com",
    //           "company": "Postman Sandbox",
    //           "business_id": 1966214,
    //           "unacknowledged_change": false,
    //           "active": true
    //         },
    //         {
    //           "id": 6446130,
    //           "group_id": 4942664,
    //           "role": "owner",
    //           "identity_id": 1882548,
    //           "first_name": "Ryan",
    //           "last_name": "Marr",
    //           "email": "api.freshbooks@gmail.com",
    //           "company": "Postman Sandbox",
    //           "business_id": 1966214,
    //           "unacknowledged_change": false,
    //           "active": true
    //         }
    //       ]
    //     },
    //     "date_format": "mm/dd/yyyy",
    //     "address": {
    //       "id": 2421054,
    //       "street": null,
    //       "city": null,
    //       "province": null,
    //       "country": "Canada",
    //       "postal_code": null
    //     },
    //     "phone_number": null,
    //     "business_clients": [
    //     ]
    //   }
    // }

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

    Date_format = CkDtObjW_Create();

    Id = CkJsonObjectW_IntOf(jResp,L"response.id");
    Name = CkJsonObjectW_stringOf(jResp,L"response.name");
    Account_id = CkJsonObjectW_stringOf(jResp,L"response.account_id");
    Business_groupId = CkJsonObjectW_IntOf(jResp,L"response.business_group.id");
    Category = CkJsonObjectW_stringOf(jResp,L"response.business_group.category");
    CkJsonObjectW_DtOf(jResp,L"response.date_format",FALSE,Date_format);
    AddressId = CkJsonObjectW_IntOf(jResp,L"response.address.id");
    Street = CkJsonObjectW_stringOf(jResp,L"response.address.street");
    City = CkJsonObjectW_stringOf(jResp,L"response.address.city");
    Province = CkJsonObjectW_stringOf(jResp,L"response.address.province");
    Country = CkJsonObjectW_stringOf(jResp,L"response.address.country");
    Postal_code = CkJsonObjectW_stringOf(jResp,L"response.address.postal_code");
    Phone_number = CkJsonObjectW_stringOf(jResp,L"response.phone_number");
    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"response.business_group.members");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        id = CkJsonObjectW_IntOf(jResp,L"response.business_group.members[i].id");
        group_id = CkJsonObjectW_IntOf(jResp,L"response.business_group.members[i].group_id");
        role = CkJsonObjectW_stringOf(jResp,L"response.business_group.members[i].role");
        identity_id = CkJsonObjectW_IntOf(jResp,L"response.business_group.members[i].identity_id");
        first_name = CkJsonObjectW_stringOf(jResp,L"response.business_group.members[i].first_name");
        last_name = CkJsonObjectW_stringOf(jResp,L"response.business_group.members[i].last_name");
        email = CkJsonObjectW_stringOf(jResp,L"response.business_group.members[i].email");
        company = CkJsonObjectW_stringOf(jResp,L"response.business_group.members[i].company");
        business_id = CkJsonObjectW_IntOf(jResp,L"response.business_group.members[i].business_id");
        unacknowledged_change = CkJsonObjectW_BoolOf(jResp,L"response.business_group.members[i].unacknowledged_change");
        active = CkJsonObjectW_BoolOf(jResp,L"response.business_group.members[i].active");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"response.business_clients");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);
    CkDtObjW_Dispose(Date_format);

    }

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
https://api.freshbooks.com/auth/api/v1/users/business/{{businessId}}

Postman Collection Item JSON

{
  "name": "List Staff",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "let jsonData = JSON.parse(responseBody);",
          "pm.environment.set(\"identityId\", jsonData.response.business_group.members[0].identity_id)"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "https://api.freshbooks.com/auth/api/v1/users/business/{{businessId}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "auth",
        "api",
        "v1",
        "users",
        "business",
        "{{businessId}}"
      ]
    }
  },
  "response": [
    {
      "name": "List Staff",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "type": "text",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "https://api.freshbooks.com/auth/api/v1/users/business/{{businessId}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "auth",
            "api",
            "v1",
            "users",
            "business",
            "{{businessId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json; charset=utf-8"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-Download-Options",
          "value": "noopen"
        },
        {
          "key": "X-Permitted-Cross-Domain-Policies",
          "value": "none"
        },
        {
          "key": "Referrer-Policy",
          "value": "strict-origin-when-cross-origin"
        },
        {
          "key": "ETag",
          "value": "W/\"8cc492fe0ab5fdbd7afc687dfe9781bf\""
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "X-Request-Id",
          "value": "16b4dc9f-df36-4050-aa07-03208a1d1e74"
        },
        {
          "key": "X-Runtime",
          "value": "0.036737"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSBAUHUFQTGhEhCQ0WQg1UDl1KG39aAV0NVBZSEAEZZQAFCBdyUxAIDVl1XhUUUEJQClxZMF8XTAtWXw4IYQpMFVQyVhZLVVYNCkEUAx5UTVIZAQRRUwkPAlJQUFQJUglaDQ0YHwJJG1gGVwYHUgYPAgBVWlIEXABAag=="
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "20"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "0"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1557346308"
        },
        {
          "key": "Retry-After",
          "value": "57"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 08 May 2018 20:10:50 GMT"
        },
        {
          "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, 08 May 2019 20:10:50 GMT"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17361-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        \"id\": 1966214,\n        \"name\": \"Postman Sandbox\",\n        \"account_id\": \"wkMd2g\",\n        \"business_group\": {\n            \"id\": 4942664,\n            \"category\": \"business\",\n            \"members\": [\n                {\n                    \"id\": 6446238,\n                    \"group_id\": 4942664,\n                    \"role\": \"business_partner\",\n                    \"identity_id\": 37256,\n                    \"first_name\": \"Marshall\",\n                    \"last_name\": \"Johnston\",\n                    \"email\": \"api.freshbooks@gmail.com\",\n                    \"company\": \"Postman Sandbox\",\n                    \"business_id\": 1966214,\n                    \"unacknowledged_change\": false,\n                    \"active\": true\n                },\n                {\n                    \"id\": 6475824,\n                    \"group_id\": 4942664,\n                    \"role\": \"business_accountant\",\n                    \"identity_id\": 75537,\n                    \"first_name\": \"Marshall\",\n                    \"last_name\": \"Johnston\",\n                    \"email\": \"api.freshbooks@gmail.com\",\n                    \"company\": \"Postman Sandbox\",\n                    \"business_id\": 1966214,\n                    \"unacknowledged_change\": false,\n                    \"active\": true\n                },\n                {\n                    \"id\": 6446130,\n                    \"group_id\": 4942664,\n                    \"role\": \"owner\",\n                    \"identity_id\": 1882548,\n                    \"first_name\": \"Ryan\",\n                    \"last_name\": \"Marr\",\n                    \"email\": \"api.freshbooks@gmail.com\",\n                    \"company\": \"Postman Sandbox\",\n                    \"business_id\": 1966214,\n                    \"unacknowledged_change\": false,\n                    \"active\": true\n                }\n            ]\n        },\n        \"date_format\": \"mm/dd/yyyy\",\n        \"address\": {\n            \"id\": 2421054,\n            \"street\": null,\n            \"city\": null,\n            \"province\": null,\n            \"country\": \"Canada\",\n            \"postal_code\": null\n        },\n        \"phone_number\": null,\n        \"business_clients\": []\n    }\n}"
    }
  ]
}