Back to Collection Items
var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Accounting_systemid: PWideChar;
Api_token: PWideChar;
Bus_phone: PWideChar;
Currency_code: PWideChar;
Display_name: PWideChar;
v_Email: PWideChar;
Fax: PWideChar;
Fname: PWideChar;
Home_phone: PWideChar;
Id: Integer;
Language: PWideChar;
Last_login: PWideChar;
Level: Integer;
Lname: PWideChar;
Mob_phone: PWideChar;
Note: PWideChar;
Num_logins: Integer;
Organization: PWideChar;
P_city: PWideChar;
P_code: PWideChar;
P_country: PWideChar;
P_province: PWideChar;
P_street: PWideChar;
P_street2: PWideChar;
Rate: PWideChar;
Role: PWideChar;
Signup_date: PWideChar;
Updated: PWideChar;
Userid: Integer;
Username: PWideChar;
Vis_state: Integer;
begin
// 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) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
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
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}"
}
]
}
