Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Handle hoJson
Variant vSbRequestBody
Handle hoSbRequestBody
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
Boolean iBillable
String sDescription
Integer iId
String sName
String sAmount
String sCode
Integer iTaskid
Integer iTax1
Integer iTax2
String sTdesc
String sTname
String sUpdated
Integer iVis_state
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// 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"
// }
// }
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "task.name" "Saving Earth" To iSuccess
Get ComUpdateString Of hoJson "task.rate.amount" "1000.00" To iSuccess
Get ComUpdateString Of hoJson "task.rate.code" "USD" To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
Send CreateComObject of hoSbRequestBody
End
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComEmitSb Of hoJson vSbRequestBody To iSuccess
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComPTextSb Of hoHttp "PUT" "https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks/{{taskId}}" vSbRequestBody "utf-8" "application/json" False False To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get ComBoolOf Of hoJResp "response.result.task.billable" To iBillable
Get ComStringOf Of hoJResp "response.result.task.description" To sDescription
Get ComIntOf Of hoJResp "response.result.task.id" To iId
Get ComStringOf Of hoJResp "response.result.task.name" To sName
Get ComStringOf Of hoJResp "response.result.task.rate.amount" To sAmount
Get ComStringOf Of hoJResp "response.result.task.rate.code" To sCode
Get ComIntOf Of hoJResp "response.result.task.taskid" To iTaskid
Get ComIntOf Of hoJResp "response.result.task.tax1" To iTax1
Get ComIntOf Of hoJResp "response.result.task.tax2" To iTax2
Get ComStringOf Of hoJResp "response.result.task.tdesc" To sTdesc
Get ComStringOf Of hoJResp "response.result.task.tname" To sTname
Get ComStringOf Of hoJResp "response.result.task.updated" To sUpdated
Get ComIntOf Of hoJResp "response.result.task.vis_state" To iVis_state
End_Procedure
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}"
}
]
}
