Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
integer li_Billable
string ls_Description
integer li_Id
string ls_Name
string ls_Amount
string ls_Code
integer li_Taskid
integer li_Tax1
integer li_Tax2
string ls_Tdesc
string ls_Tname
string ls_Updated
integer li_Vis_state
integer li_Page
integer li_Pages
integer li_Per_page
integer li_Total
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
li_Success = loo_Http.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks",loo_SbResponseBody)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_SbResponseBody
return
end if
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Http.LastHeader
Write-Debug "Failed."
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
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
li_Page = loo_JResp.IntOf("response.result.page")
li_Pages = loo_JResp.IntOf("response.result.pages")
li_Per_page = loo_JResp.IntOf("response.result.per_page")
li_Total = loo_JResp.IntOf("response.result.total")
i = 0
li_Count_i = loo_JResp.SizeOfArray("response.result.tasks")
do while i < li_Count_i
loo_JResp.I = i
li_Billable = loo_JResp.BoolOf("response.result.tasks[i].billable")
ls_Description = loo_JResp.StringOf("response.result.tasks[i].description")
li_Id = loo_JResp.IntOf("response.result.tasks[i].id")
ls_Name = loo_JResp.StringOf("response.result.tasks[i].name")
ls_Amount = loo_JResp.StringOf("response.result.tasks[i].rate.amount")
ls_Code = loo_JResp.StringOf("response.result.tasks[i].rate.code")
li_Taskid = loo_JResp.IntOf("response.result.tasks[i].taskid")
li_Tax1 = loo_JResp.IntOf("response.result.tasks[i].tax1")
li_Tax2 = loo_JResp.IntOf("response.result.tasks[i].tax2")
ls_Tdesc = loo_JResp.StringOf("response.result.tasks[i].tdesc")
ls_Tname = loo_JResp.StringOf("response.result.tasks[i].tname")
ls_Updated = loo_JResp.StringOf("response.result.tasks[i].updated")
li_Vis_state = loo_JResp.IntOf("response.result.tasks[i].vis_state")
i = i + 1
loop
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
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}"
}
]
}
