Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lnBillable
LOCAL lcDescription
LOCAL lnId
LOCAL lcName
LOCAL lcAmount
LOCAL lcCode
LOCAL lnTaskid
LOCAL lnTax1
LOCAL lnTax2
LOCAL lcTdesc
LOCAL lcTname
LOCAL lcUpdated
LOCAL lnVis_state
LOCAL lnPage
LOCAL lnPages
LOCAL lnPer_page
LOCAL lnTotal
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
* 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
lnPage = loJResp.IntOf("response.result.page")
lnPages = loJResp.IntOf("response.result.pages")
lnPer_page = loJResp.IntOf("response.result.per_page")
lnTotal = loJResp.IntOf("response.result.total")
i = 0
lnCount_i = loJResp.SizeOfArray("response.result.tasks")
DO WHILE i < lnCount_i
loJResp.I = i
lnBillable = loJResp.BoolOf("response.result.tasks[i].billable")
lcDescription = loJResp.StringOf("response.result.tasks[i].description")
lnId = loJResp.IntOf("response.result.tasks[i].id")
lcName = loJResp.StringOf("response.result.tasks[i].name")
lcAmount = loJResp.StringOf("response.result.tasks[i].rate.amount")
lcCode = loJResp.StringOf("response.result.tasks[i].rate.code")
lnTaskid = loJResp.IntOf("response.result.tasks[i].taskid")
lnTax1 = loJResp.IntOf("response.result.tasks[i].tax1")
lnTax2 = loJResp.IntOf("response.result.tasks[i].tax2")
lcTdesc = loJResp.StringOf("response.result.tasks[i].tdesc")
lcTname = loJResp.StringOf("response.result.tasks[i].tname")
lcUpdated = loJResp.StringOf("response.result.tasks[i].updated")
lnVis_state = loJResp.IntOf("response.result.tasks[i].vis_state")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
