Chilkat Online Tools

TCL / New FreshBooks / Update Task

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

# 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"
#     }
#   }
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "task.name" "Saving Earth"
CkJsonObject_UpdateString $json "task.rate.amount" "1000.00"
CkJsonObject_UpdateString $json "task.rate.code" "USD"

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks/{{taskId}}" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $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

set Billable [CkJsonObject_BoolOf $jResp "response.result.task.billable"]
set Description [CkJsonObject_stringOf $jResp "response.result.task.description"]
set Id [CkJsonObject_IntOf $jResp "response.result.task.id"]
set Name [CkJsonObject_stringOf $jResp "response.result.task.name"]
set Amount [CkJsonObject_stringOf $jResp "response.result.task.rate.amount"]
set Code [CkJsonObject_stringOf $jResp "response.result.task.rate.code"]
set Taskid [CkJsonObject_IntOf $jResp "response.result.task.taskid"]
set Tax1 [CkJsonObject_IntOf $jResp "response.result.task.tax1"]
set Tax2 [CkJsonObject_IntOf $jResp "response.result.task.tax2"]
set Tdesc [CkJsonObject_stringOf $jResp "response.result.task.tdesc"]
set Tname [CkJsonObject_stringOf $jResp "response.result.task.tname"]
set Updated [CkJsonObject_stringOf $jResp "response.result.task.updated"]
set Vis_state [CkJsonObject_IntOf $jResp "response.result.task.vis_state"]

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

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}"
    }
  ]
}