Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkHttpResponseW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW json;
HCkStringBuilderW sbRequestBody;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
BOOL Billable;
const wchar_t *Description;
int Id;
const wchar_t *Name;
const wchar_t *Amount;
const wchar_t *Code;
int Taskid;
int Tax1;
int Tax2;
const wchar_t *Tdesc;
const wchar_t *Tname;
const wchar_t *Updated;
int Vis_state;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_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.
// {
// "task": {
// "vis_state": 1
// }
// }
json = CkJsonObjectW_Create();
CkJsonObjectW_UpdateInt(json,L"task.vis_state",1);
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
sbRequestBody = CkStringBuilderW_Create();
CkJsonObjectW_EmitSb(json,sbRequestBody);
resp = CkHttpW_PTextSb(http,L"PUT",L"https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks/{{taskId}}",sbRequestBody,L"utf-8",L"application/json",FALSE,FALSE);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "response": {
// "result": {
// "task": {
// "billable": true,
// "description": "Hourly rate for doing positive things",
// "id": 74830,
// "name": "Saving Earth",
// "rate": {
// "amount": "1000.00",
// "code": "USD"
// },
// "taskid": 74830,
// "tax1": 0,
// "tax2": 0,
// "tdesc": "Hourly rate for doing positive things",
// "tname": "Saving Earth",
// "updated": "2019-04-24 14:39:45",
// "vis_state": 1
// }
// }
// }
// }
// 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.
Billable = CkJsonObjectW_BoolOf(jResp,L"response.result.task.billable");
Description = CkJsonObjectW_stringOf(jResp,L"response.result.task.description");
Id = CkJsonObjectW_IntOf(jResp,L"response.result.task.id");
Name = CkJsonObjectW_stringOf(jResp,L"response.result.task.name");
Amount = CkJsonObjectW_stringOf(jResp,L"response.result.task.rate.amount");
Code = CkJsonObjectW_stringOf(jResp,L"response.result.task.rate.code");
Taskid = CkJsonObjectW_IntOf(jResp,L"response.result.task.taskid");
Tax1 = CkJsonObjectW_IntOf(jResp,L"response.result.task.tax1");
Tax2 = CkJsonObjectW_IntOf(jResp,L"response.result.task.tax2");
Tdesc = CkJsonObjectW_stringOf(jResp,L"response.result.task.tdesc");
Tname = CkJsonObjectW_stringOf(jResp,L"response.result.task.tname");
Updated = CkJsonObjectW_stringOf(jResp,L"response.result.task.updated");
Vis_state = CkJsonObjectW_IntOf(jResp,L"response.result.task.vis_state");
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"task": {
"vis_state": 1
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks/{{taskId}}
Postman Collection Item JSON
{
"name": "Delete Task",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"task\": {\n \"vis_state\": 1\n }\n}\n"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks/{{taskId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"projects",
"tasks",
"{{taskId}}"
]
}
},
"response": [
{
"name": "Delete Task",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"task\": {\n \"vis_state\": 1\n }\n}\n"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks/{{taskId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"projects",
"tasks",
"{{taskId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gUQ1lZBwUXEQoWWRFTGhgCH1UXUAFSC1tdBgdTVlQNAglRUlMbAg5KRgVTB1IAUltSVAsADlsNAABHFQdQDUAHOQ=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:39:45 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:39:45 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 \"task\": {\n \"billable\": true,\n \"description\": \"Hourly rate for doing positive things\",\n \"id\": 74830,\n \"name\": \"Saving Earth\",\n \"rate\": {\n \"amount\": \"1000.00\",\n \"code\": \"USD\"\n },\n \"taskid\": 74830,\n \"tax1\": 0,\n \"tax2\": 0,\n \"tdesc\": \"Hourly rate for doing positive things\",\n \"tname\": \"Saving Earth\",\n \"updated\": \"2019-04-24 14:39:45\",\n \"vis_state\": 1\n }\n }\n }\n}"
}
]
}
