Chilkat Online Tools

C / New FreshBooks / Update Staff

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>
#include <C_CkHttpResponse.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject json;
    HCkStringBuilder sbRequestBody;
    HCkHttpResponse resp;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *Accounting_systemid;
    const char *Api_token;
    const char *Bus_phone;
    const char *Currency_code;
    const char *Display_name;
    const char *v_Email;
    const char *Fax;
    const char *Fname;
    const char *Home_phone;
    int Id;
    const char *Language;
    const char *Last_login;
    int Level;
    const char *Lname;
    const char *Mob_phone;
    const char *Note;
    int Num_logins;
    const char *Organization;
    const char *P_city;
    const char *P_code;
    const char *P_country;
    const char *P_province;
    const char *P_street;
    const char *P_street2;
    const char *Rate;
    const char *Role;
    const char *Signup_date;
    const char *Updated;
    int Userid;
    const char *Username;
    int Vis_state;

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

    http = CkHttp_Create();

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "staff": {
    //     "fname": "Ryen"
    //   }
    // }

    json = CkJsonObject_Create();
    CkJsonObject_UpdateString(json,"staff.fname","Ryen");

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

    sbRequestBody = CkStringBuilder_Create();
    CkJsonObject_EmitSb(json,sbRequestBody);

    resp = CkHttp_PTextSb(http,"PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/users/staffs/{{staffId}}",sbRequestBody,"utf-8","application/json",FALSE,FALSE);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        CkStringBuilder_Dispose(sbRequestBody);
        return;
    }

    sbResponseBody = CkStringBuilder_Create();
    CkHttpResponse_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttpResponse_getStatusCode(resp);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttpResponse_header(resp));
        printf("Failed.\n");
        CkHttpResponse_Dispose(resp);
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        CkStringBuilder_Dispose(sbRequestBody);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    CkHttpResponse_Dispose(resp);

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

    // {
    //   "response": {
    //     "result": {
    //       "staff": {
    //         "accounting_systemid": "wkMd2g",
    //         "api_token": "9249ac8633763523fe614cdeb28787b9",
    //         "bus_phone": "",
    //         "currency_code": null,
    //         "display_name": "RyenMarr",
    //         "email": "api.freshbooks@gmail.com",
    //         "fax": "",
    //         "fname": "Ryen",
    //         "home_phone": null,
    //         "id": 1,
    //         "language": "en",
    //         "last_login": null,
    //         "level": 3,
    //         "lname": "Marr",
    //         "mob_phone": "",
    //         "note": null,
    //         "num_logins": 0,
    //         "organization": "Postman Sandbox",
    //         "p_city": "",
    //         "p_code": "",
    //         "p_country": "",
    //         "p_province": "",
    //         "p_street": "",
    //         "p_street2": "",
    //         "rate": null,
    //         "role": "admin",
    //         "signup_date": "2019-04-18 09:14:53",
    //         "updated": "2019-04-24 14:37:58",
    //         "userid": 1,
    //         "username": "rmarr@freshbooks.com",
    //         "vis_state": 0
    //       }
    //     }
    //   }
    // }

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

    Accounting_systemid = CkJsonObject_stringOf(jResp,"response.result.staff.accounting_systemid");
    Api_token = CkJsonObject_stringOf(jResp,"response.result.staff.api_token");
    Bus_phone = CkJsonObject_stringOf(jResp,"response.result.staff.bus_phone");
    Currency_code = CkJsonObject_stringOf(jResp,"response.result.staff.currency_code");
    Display_name = CkJsonObject_stringOf(jResp,"response.result.staff.display_name");
    v_Email = CkJsonObject_stringOf(jResp,"response.result.staff.email");
    Fax = CkJsonObject_stringOf(jResp,"response.result.staff.fax");
    Fname = CkJsonObject_stringOf(jResp,"response.result.staff.fname");
    Home_phone = CkJsonObject_stringOf(jResp,"response.result.staff.home_phone");
    Id = CkJsonObject_IntOf(jResp,"response.result.staff.id");
    Language = CkJsonObject_stringOf(jResp,"response.result.staff.language");
    Last_login = CkJsonObject_stringOf(jResp,"response.result.staff.last_login");
    Level = CkJsonObject_IntOf(jResp,"response.result.staff.level");
    Lname = CkJsonObject_stringOf(jResp,"response.result.staff.lname");
    Mob_phone = CkJsonObject_stringOf(jResp,"response.result.staff.mob_phone");
    Note = CkJsonObject_stringOf(jResp,"response.result.staff.note");
    Num_logins = CkJsonObject_IntOf(jResp,"response.result.staff.num_logins");
    Organization = CkJsonObject_stringOf(jResp,"response.result.staff.organization");
    P_city = CkJsonObject_stringOf(jResp,"response.result.staff.p_city");
    P_code = CkJsonObject_stringOf(jResp,"response.result.staff.p_code");
    P_country = CkJsonObject_stringOf(jResp,"response.result.staff.p_country");
    P_province = CkJsonObject_stringOf(jResp,"response.result.staff.p_province");
    P_street = CkJsonObject_stringOf(jResp,"response.result.staff.p_street");
    P_street2 = CkJsonObject_stringOf(jResp,"response.result.staff.p_street2");
    Rate = CkJsonObject_stringOf(jResp,"response.result.staff.rate");
    Role = CkJsonObject_stringOf(jResp,"response.result.staff.role");
    Signup_date = CkJsonObject_stringOf(jResp,"response.result.staff.signup_date");
    Updated = CkJsonObject_stringOf(jResp,"response.result.staff.updated");
    Userid = CkJsonObject_IntOf(jResp,"response.result.staff.userid");
    Username = CkJsonObject_stringOf(jResp,"response.result.staff.username");
    Vis_state = CkJsonObject_IntOf(jResp,"response.result.staff.vis_state");


    CkHttp_Dispose(http);
    CkJsonObject_Dispose(json);
    CkStringBuilder_Dispose(sbRequestBody);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "staff": {
    "fname": "Ryen"
  }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/users/staffs/{{staffId}}

Postman Collection Item JSON

{
  "name": "Update Staff",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"staff\": {\n    \"fname\": \"Ryen\"\n  }\n}"
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/staffs/{{staffId}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "users",
        "staffs",
        "{{staffId}}"
      ]
    }
  },
  "response": [
    {
      "name": "Update Staff",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"staff\": {\n    \"fname\": \"Ryen\"\n  }\n}"
        },
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/staffs/{{staffId}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "users",
            "staffs",
            "{{staffId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gRQlNBEVwQFlEEXkAUCBgCHVQMVQlUBFNRDgFXVlsACwZTTVYHHRVRUAAPUVNUWwACAQ9TDgwCEB8DWA1CBG4="
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:37:58 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": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Date",
          "value": "Wed, 24 Apr 2019 18:37:58 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            \"staff\": {\n                \"accounting_systemid\": \"wkMd2g\",\n                \"api_token\": \"9249ac8633763523fe614cdeb28787b9\",\n                \"bus_phone\": \"\",\n                \"currency_code\": null,\n                \"display_name\": \"RyenMarr\",\n                \"email\": \"api.freshbooks@gmail.com\",\n                \"fax\": \"\",\n                \"fname\": \"Ryen\",\n                \"home_phone\": null,\n                \"id\": 1,\n                \"language\": \"en\",\n                \"last_login\": null,\n                \"level\": 3,\n                \"lname\": \"Marr\",\n                \"mob_phone\": \"\",\n                \"note\": null,\n                \"num_logins\": 0,\n                \"organization\": \"Postman Sandbox\",\n                \"p_city\": \"\",\n                \"p_code\": \"\",\n                \"p_country\": \"\",\n                \"p_province\": \"\",\n                \"p_street\": \"\",\n                \"p_street2\": \"\",\n                \"rate\": null,\n                \"role\": \"admin\",\n                \"signup_date\": \"2019-04-18 09:14:53\",\n                \"updated\": \"2019-04-24 14:37:58\",\n                \"userid\": 1,\n                \"username\": \"rmarr@freshbooks.com\",\n                \"vis_state\": 0\n            }\n        }\n    }\n}"
    }
  ]
}