Chilkat Online Tools

Python / New FreshBooks / Update Task

Back to Collection Items

import sys
import chilkat2

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

http = chilkat2.Http()

# 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 = chilkat2.JsonObject()
json.UpdateString("task.name","Saving Earth")
json.UpdateString("task.rate.amount","1000.00")
json.UpdateString("task.rate.code","USD")

# Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("Content-Type","application/json")

sbRequestBody = chilkat2.StringBuilder()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks/{{taskId}}",sbRequestBody,"utf-8","application/json",False,False)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)

jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

print("Response Body:")
print(jResp.Emit())

respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(resp.Header)
    print("Failed.")

    sys.exit()

# 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 = jResp.BoolOf("response.result.task.billable")
Description = jResp.StringOf("response.result.task.description")
Id = jResp.IntOf("response.result.task.id")
Name = jResp.StringOf("response.result.task.name")
Amount = jResp.StringOf("response.result.task.rate.amount")
Code = jResp.StringOf("response.result.task.rate.code")
Taskid = jResp.IntOf("response.result.task.taskid")
Tax1 = jResp.IntOf("response.result.task.tax1")
Tax2 = jResp.IntOf("response.result.task.tax2")
Tdesc = jResp.StringOf("response.result.task.tdesc")
Tname = jResp.StringOf("response.result.task.tname")
Updated = jResp.StringOf("response.result.task.updated")
Vis_state = jResp.IntOf("response.result.task.vis_state")

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