Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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": {
; "name": "Saving Earth",
; "rate": {
; "amount": "1000.00",
; "code": "USD"
; }
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"task.name","Saving Earth")
CkJsonObject::ckUpdateString(json,"task.rate.amount","1000.00")
CkJsonObject::ckUpdateString(json,"task.rate.code","USD")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks/{{taskId}}",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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:22",
; "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
Billable.i = CkJsonObject::ckBoolOf(jResp,"response.result.task.billable")
Description.s = CkJsonObject::ckStringOf(jResp,"response.result.task.description")
Id.i = CkJsonObject::ckIntOf(jResp,"response.result.task.id")
Name.s = CkJsonObject::ckStringOf(jResp,"response.result.task.name")
Amount.s = CkJsonObject::ckStringOf(jResp,"response.result.task.rate.amount")
Code.s = CkJsonObject::ckStringOf(jResp,"response.result.task.rate.code")
Taskid.i = CkJsonObject::ckIntOf(jResp,"response.result.task.taskid")
Tax1.i = CkJsonObject::ckIntOf(jResp,"response.result.task.tax1")
Tax2.i = CkJsonObject::ckIntOf(jResp,"response.result.task.tax2")
Tdesc.s = CkJsonObject::ckStringOf(jResp,"response.result.task.tdesc")
Tname.s = CkJsonObject::ckStringOf(jResp,"response.result.task.tname")
Updated.s = CkJsonObject::ckStringOf(jResp,"response.result.task.updated")
Vis_state.i = CkJsonObject::ckIntOf(jResp,"response.result.task.vis_state")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"task": {
"name": "Saving Earth",
"rate": {
"amount": "1000.00",
"code": "USD"
}
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks/{{taskId}}
Postman Collection Item JSON
{
"name": "Update Task",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"task\": {\n \"name\": \"Saving Earth\",\n \"rate\": {\n \"amount\": \"1000.00\",\n \"code\": \"USD\"\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": "Update Task",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"task\": {\n \"name\": \"Saving Earth\",\n \"rate\": {\n \"amount\": \"1000.00\",\n \"code\": \"USD\"\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": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gUQ1lZBwUXEQoWWRFTGhgCH1UXUAFZA1tXBgVSVVMIAgdUWE4GAQNKRgAGAgRUBlcJV15UWgFQBANHFQdQDUAHOQ=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:39:22 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:22 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:22\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
