Chilkat Online Tools

Xojo / New FreshBooks / List Tasks

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

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

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks",sbResponseBody)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(http.LastHeader)
    System.DebugLog("Failed.")
    Return
End If

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "response": {
//     "result": {
//       "page": 1,
//       "pages": 1,
//       "per_page": 15,
//       "tasks": [
//         {
//           "billable": true,
//           "description": "",
//           "id": 55226,
//           "name": "Computer Hardware",
//           "rate": {
//             "amount": "0.00",
//             "code": "USD"
//           },
//           "taskid": 55226,
//           "tax1": 0,
//           "tax2": 0,
//           "tdesc": "",
//           "tname": "Computer Hardware",
//           "updated": "2019-04-18 09:14:53",
//           "vis_state": 0
//         },
//         {
//           "billable": true,
//           "description": "Specific consulting services for a specific reason",
//           "id": 70986,
//           "name": "Consulting",
//           "rate": {
//             "amount": "45.00",
//             "code": "USD"
//           },
//           "taskid": 70986,
//           "tax1": 0,
//           "tax2": 0,
//           "tdesc": "Specific consulting services for a specific reason",
//           "tname": "Consulting",
//           "updated": "2019-04-23 14:47:22",
//           "vis_state": 0
//         },
//         {
//           "billable": true,
//           "description": "Specific contracting services for a specific reason",
//           "id": 70988,
//           "name": "Contracting",
//           "rate": {
//             "amount": "45.00",
//             "code": "USD"
//           },
//           "taskid": 70988,
//           "tax1": 0,
//           "tax2": 0,
//           "tdesc": "Specific contracting services for a specific reason",
//           "tname": "Contracting",
//           "updated": "2019-04-23 14:48:11",
//           "vis_state": 0
//         },
//         {
//           "billable": true,
//           "description": "Hourly rate for doing positive things",
//           "id": 70992,
//           "name": "Saving Planet",
//           "rate": {
//             "amount": "1000.00",
//             "code": "USD"
//           },
//           "taskid": 70992,
//           "tax1": 0,
//           "tax2": 0,
//           "tdesc": "Hourly rate for doing positive things",
//           "tname": "Saving Planet",
//           "updated": "2019-04-23 14:50:57",
//           "vis_state": 0
//         }
//       ],
//       "total": 4
//     }
//   }
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Dim billable As Boolean
Dim description As String
Dim id As Int32
Dim name As String
Dim Amount As String
Dim Code As String
Dim taskid As Int32
Dim tax1 As Int32
Dim tax2 As Int32
Dim tdesc As String
Dim tname As String
Dim updated As String
Dim vis_state As Int32

Dim Page As Int32
Page = jResp.IntOf("response.result.page")
Dim Pages As Int32
Pages = jResp.IntOf("response.result.pages")
Dim Per_page As Int32
Per_page = jResp.IntOf("response.result.per_page")
Dim Total As Int32
Total = jResp.IntOf("response.result.total")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("response.result.tasks")
While i < count_i
    jResp.I = i
    billable = jResp.BoolOf("response.result.tasks[i].billable")
    description = jResp.StringOf("response.result.tasks[i].description")
    id = jResp.IntOf("response.result.tasks[i].id")
    name = jResp.StringOf("response.result.tasks[i].name")
    Amount = jResp.StringOf("response.result.tasks[i].rate.amount")
    Code = jResp.StringOf("response.result.tasks[i].rate.code")
    taskid = jResp.IntOf("response.result.tasks[i].taskid")
    tax1 = jResp.IntOf("response.result.tasks[i].tax1")
    tax2 = jResp.IntOf("response.result.tasks[i].tax2")
    tdesc = jResp.StringOf("response.result.tasks[i].tdesc")
    tname = jResp.StringOf("response.result.tasks[i].tname")
    updated = jResp.StringOf("response.result.tasks[i].updated")
    vis_state = jResp.IntOf("response.result.tasks[i].vis_state")
    i = i + 1
Wend

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks

Postman Collection Item JSON

{
  "name": "List Tasks",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "let jsonData = JSON.parse(responseBody); ",
          "pm.environment.set(\"taskId\", jsonData.response.result.tasks[0].taskid);"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks\n",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "projects",
        "tasks\n"
      ]
    }
  },
  "response": [
    {
      "name": "List Tasks",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "projects",
            "tasks"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gUQ1lZBwUXEQoWWRFTSxYeA0kJTwBTAlRcAwVXUFcBBwdRUVsPHRpXSBNVBgZUBVtWVltbCl5QCwVcG01XAF8RAWs="
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:38:47 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": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "Date",
          "value": "Wed, 24 Apr 2019 18:38:48 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            \"page\": 1,\n            \"pages\": 1,\n            \"per_page\": 15,\n            \"tasks\": [\n                {\n                    \"billable\": true,\n                    \"description\": \"\",\n                    \"id\": 55226,\n                    \"name\": \"Computer Hardware\",\n                    \"rate\": {\n                        \"amount\": \"0.00\",\n                        \"code\": \"USD\"\n                    },\n                    \"taskid\": 55226,\n                    \"tax1\": 0,\n                    \"tax2\": 0,\n                    \"tdesc\": \"\",\n                    \"tname\": \"Computer Hardware\",\n                    \"updated\": \"2019-04-18 09:14:53\",\n                    \"vis_state\": 0\n                },\n                {\n                    \"billable\": true,\n                    \"description\": \"Specific consulting services for a specific reason\",\n                    \"id\": 70986,\n                    \"name\": \"Consulting\",\n                    \"rate\": {\n                        \"amount\": \"45.00\",\n                        \"code\": \"USD\"\n                    },\n                    \"taskid\": 70986,\n                    \"tax1\": 0,\n                    \"tax2\": 0,\n                    \"tdesc\": \"Specific consulting services for a specific reason\",\n                    \"tname\": \"Consulting\",\n                    \"updated\": \"2019-04-23 14:47:22\",\n                    \"vis_state\": 0\n                },\n                {\n                    \"billable\": true,\n                    \"description\": \"Specific contracting services for a specific reason\",\n                    \"id\": 70988,\n                    \"name\": \"Contracting\",\n                    \"rate\": {\n                        \"amount\": \"45.00\",\n                        \"code\": \"USD\"\n                    },\n                    \"taskid\": 70988,\n                    \"tax1\": 0,\n                    \"tax2\": 0,\n                    \"tdesc\": \"Specific contracting services for a specific reason\",\n                    \"tname\": \"Contracting\",\n                    \"updated\": \"2019-04-23 14:48:11\",\n                    \"vis_state\": 0\n                },\n                {\n                    \"billable\": true,\n                    \"description\": \"Hourly rate for doing positive things\",\n                    \"id\": 70992,\n                    \"name\": \"Saving Planet\",\n                    \"rate\": {\n                        \"amount\": \"1000.00\",\n                        \"code\": \"USD\"\n                    },\n                    \"taskid\": 70992,\n                    \"tax1\": 0,\n                    \"tax2\": 0,\n                    \"tdesc\": \"Hourly rate for doing positive things\",\n                    \"tname\": \"Saving Planet\",\n                    \"updated\": \"2019-04-23 14:50:57\",\n                    \"vis_state\": 0\n                }\n            ],\n            \"total\": 4\n        }\n    }\n}"
    }
  ]
}