Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
Integer iId
Integer iIdentity_id
String sTimer
Boolean iIs_logged
String sStarted_at
String sCreated_at
Integer iDuration
Integer iClient_id
Integer iProject_id
String sPending_client
String sPending_project
String sPending_task
String sTask_id
String sService_id
String sNote
Boolean iActive
Boolean iBillable
Boolean iBilled
Boolean iInternal
String sRetainer_id
Integer iTotal_logged
Integer iTotal_unbilled
Integer iTotal
Integer iPer_page
Integer iPage
Integer iPages
Integer i
Integer iCount_i
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://api.freshbooks.com/timetracking/business/{{businessId}}/time_entries" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "meta": {
// "total_logged": 54000,
// "total_unbilled": 0,
// "total": 7,
// "per_page": 7,
// "page": 1,
// "pages": 1
// },
// "time_entries": [
// {
// "id": 47634496,
// "identity_id": 1882548,
// "timer": null,
// "is_logged": true,
// "started_at": "2016-08-16T20:00:00Z",
// "created_at": "2019-04-18T15:16:32Z",
// "duration": 7200,
// "client_id": 31006,
// "project_id": 2976412,
// "pending_client": null,
// "pending_project": null,
// "pending_task": null,
// "task_id": null,
// "service_id": null,
// "note": "Stuff",
// "active": true,
// "billable": false,
// "billed": false,
// "internal": false,
// "retainer_id": null
// },
// {
// "id": 47632920,
// "identity_id": 1882548,
// "timer": null,
// "is_logged": true,
// "started_at": "2016-08-16T20:00:00Z",
// "created_at": "2019-04-18T14:58:17Z",
// "duration": 7200,
// "client_id": 31006,
// "project_id": 2976412,
// "pending_client": null,
// "pending_project": null,
// "pending_task": null,
// "task_id": null,
// "service_id": null,
// "note": "Stuff",
// "active": true,
// "billable": false,
// "billed": false,
// "internal": false,
// "retainer_id": null
// },
// {
// "id": 47632874,
// "identity_id": 1882548,
// "timer": null,
// "is_logged": true,
// "started_at": "2016-08-16T20:00:00Z",
// "created_at": "2019-04-18T14:57:34Z",
// "duration": 7200,
// "client_id": 31006,
// "project_id": 2976412,
// "pending_client": null,
// "pending_project": null,
// "pending_task": null,
// "task_id": null,
// "service_id": null,
// "note": "Stuff",
// "active": true,
// "billable": false,
// "billed": false,
// "internal": false,
// "retainer_id": null
// },
// {
// "id": 47630476,
// "identity_id": 1882548,
// "timer": null,
// "is_logged": true,
// "started_at": "2019-04-15T04:00:00Z",
// "created_at": "2019-04-18T14:11:34Z",
// "duration": 7200,
// "client_id": 31006,
// "project_id": 2976412,
// "pending_client": null,
// "pending_project": null,
// "pending_task": null,
// "task_id": null,
// "service_id": 3575792,
// "note": null,
// "active": true,
// "billable": false,
// "billed": false,
// "internal": false,
// "retainer_id": null
// },
// {
// "id": 47630478,
// "identity_id": 1882548,
// "timer": null,
// "is_logged": true,
// "started_at": "2019-04-17T04:00:00Z",
// "created_at": "2019-04-18T14:11:34Z",
// "duration": 7200,
// "client_id": 31006,
// "project_id": 2976412,
// "pending_client": null,
// "pending_project": null,
// "pending_task": null,
// "task_id": null,
// "service_id": 3575792,
// "note": null,
// "active": true,
// "billable": false,
// "billed": false,
// "internal": false,
// "retainer_id": null
// },
// {
// "id": 47630480,
// "identity_id": 1882548,
// "timer": null,
// "is_logged": true,
// "started_at": "2019-04-18T04:00:00Z",
// "created_at": "2019-04-18T14:11:34Z",
// "duration": 7200,
// "client_id": 31006,
// "project_id": 2976412,
// "pending_client": null,
// "pending_project": null,
// "pending_task": null,
// "task_id": null,
// "service_id": 3575792,
// "note": null,
// "active": true,
// "billable": false,
// "billed": false,
// "internal": false,
// "retainer_id": null
// },
// {
// "id": 47630482,
// "identity_id": 1882548,
// "timer": null,
// "is_logged": true,
// "started_at": "2019-04-19T04:00:00Z",
// "created_at": "2019-04-18T14:11:34Z",
// "duration": 10800,
// "client_id": 31006,
// "project_id": 2976412,
// "pending_client": null,
// "pending_project": null,
// "pending_task": null,
// "task_id": null,
// "service_id": 3575792,
// "note": null,
// "active": true,
// "billable": false,
// "billed": false,
// "internal": false,
// "retainer_id": null
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComIntOf Of hoJResp "meta.total_logged" To iTotal_logged
Get ComIntOf Of hoJResp "meta.total_unbilled" To iTotal_unbilled
Get ComIntOf Of hoJResp "meta.total" To iTotal
Get ComIntOf Of hoJResp "meta.per_page" To iPer_page
Get ComIntOf Of hoJResp "meta.page" To iPage
Get ComIntOf Of hoJResp "meta.pages" To iPages
Move 0 To i
Get ComSizeOfArray Of hoJResp "time_entries" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComIntOf Of hoJResp "time_entries[i].id" To iId
Get ComIntOf Of hoJResp "time_entries[i].identity_id" To iIdentity_id
Get ComStringOf Of hoJResp "time_entries[i].timer" To sTimer
Get ComBoolOf Of hoJResp "time_entries[i].is_logged" To iIs_logged
Get ComStringOf Of hoJResp "time_entries[i].started_at" To sStarted_at
Get ComStringOf Of hoJResp "time_entries[i].created_at" To sCreated_at
Get ComIntOf Of hoJResp "time_entries[i].duration" To iDuration
Get ComIntOf Of hoJResp "time_entries[i].client_id" To iClient_id
Get ComIntOf Of hoJResp "time_entries[i].project_id" To iProject_id
Get ComStringOf Of hoJResp "time_entries[i].pending_client" To sPending_client
Get ComStringOf Of hoJResp "time_entries[i].pending_project" To sPending_project
Get ComStringOf Of hoJResp "time_entries[i].pending_task" To sPending_task
Get ComStringOf Of hoJResp "time_entries[i].task_id" To sTask_id
Get ComStringOf Of hoJResp "time_entries[i].service_id" To sService_id
Get ComStringOf Of hoJResp "time_entries[i].note" To sNote
Get ComBoolOf Of hoJResp "time_entries[i].active" To iActive
Get ComBoolOf Of hoJResp "time_entries[i].billable" To iBillable
Get ComBoolOf Of hoJResp "time_entries[i].billed" To iBilled
Get ComBoolOf Of hoJResp "time_entries[i].internal" To iInternal
Get ComStringOf Of hoJResp "time_entries[i].retainer_id" To sRetainer_id
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.freshbooks.com/timetracking/business/{{businessId}}/time_entries
Postman Collection Item JSON
{
"name": "List Entries",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/timetracking/business/{{businessId}}/time_entries",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"timetracking",
"business",
"{{businessId}}",
"time_entries"
]
}
},
"response": [
{
"name": "List Entries",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/timetracking/business/{{businessId}}/time_entries",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"timetracking",
"business",
"{{businessId}}",
"time_entries"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "X-Version",
"value": "1904.25.0"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNFlkPXT1dVkBAWgBKT0MEQA0RRFQEXBdRXlU7BAxDQ14DFxMaA05WTVIHVwhXAQwFAQpVAFgAUwJTSBsGTUQGAQYJUFQEUgdRBQcBUAFURE8EUQ5LB2U="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:42:32 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"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": "Content-Length",
"value": "3133"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 18:42:32 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": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"total_logged\": 54000,\n \"total_unbilled\": 0,\n \"total\": 7,\n \"per_page\": 7,\n \"page\": 1,\n \"pages\": 1\n },\n \"time_entries\": [\n {\n \"id\": 47634496,\n \"identity_id\": 1882548,\n \"timer\": null,\n \"is_logged\": true,\n \"started_at\": \"2016-08-16T20:00:00Z\",\n \"created_at\": \"2019-04-18T15:16:32Z\",\n \"duration\": 7200,\n \"client_id\": 31006,\n \"project_id\": 2976412,\n \"pending_client\": null,\n \"pending_project\": null,\n \"pending_task\": null,\n \"task_id\": null,\n \"service_id\": null,\n \"note\": \"Stuff\",\n \"active\": true,\n \"billable\": false,\n \"billed\": false,\n \"internal\": false,\n \"retainer_id\": null\n },\n {\n \"id\": 47632920,\n \"identity_id\": 1882548,\n \"timer\": null,\n \"is_logged\": true,\n \"started_at\": \"2016-08-16T20:00:00Z\",\n \"created_at\": \"2019-04-18T14:58:17Z\",\n \"duration\": 7200,\n \"client_id\": 31006,\n \"project_id\": 2976412,\n \"pending_client\": null,\n \"pending_project\": null,\n \"pending_task\": null,\n \"task_id\": null,\n \"service_id\": null,\n \"note\": \"Stuff\",\n \"active\": true,\n \"billable\": false,\n \"billed\": false,\n \"internal\": false,\n \"retainer_id\": null\n },\n {\n \"id\": 47632874,\n \"identity_id\": 1882548,\n \"timer\": null,\n \"is_logged\": true,\n \"started_at\": \"2016-08-16T20:00:00Z\",\n \"created_at\": \"2019-04-18T14:57:34Z\",\n \"duration\": 7200,\n \"client_id\": 31006,\n \"project_id\": 2976412,\n \"pending_client\": null,\n \"pending_project\": null,\n \"pending_task\": null,\n \"task_id\": null,\n \"service_id\": null,\n \"note\": \"Stuff\",\n \"active\": true,\n \"billable\": false,\n \"billed\": false,\n \"internal\": false,\n \"retainer_id\": null\n },\n {\n \"id\": 47630476,\n \"identity_id\": 1882548,\n \"timer\": null,\n \"is_logged\": true,\n \"started_at\": \"2019-04-15T04:00:00Z\",\n \"created_at\": \"2019-04-18T14:11:34Z\",\n \"duration\": 7200,\n \"client_id\": 31006,\n \"project_id\": 2976412,\n \"pending_client\": null,\n \"pending_project\": null,\n \"pending_task\": null,\n \"task_id\": null,\n \"service_id\": 3575792,\n \"note\": null,\n \"active\": true,\n \"billable\": false,\n \"billed\": false,\n \"internal\": false,\n \"retainer_id\": null\n },\n {\n \"id\": 47630478,\n \"identity_id\": 1882548,\n \"timer\": null,\n \"is_logged\": true,\n \"started_at\": \"2019-04-17T04:00:00Z\",\n \"created_at\": \"2019-04-18T14:11:34Z\",\n \"duration\": 7200,\n \"client_id\": 31006,\n \"project_id\": 2976412,\n \"pending_client\": null,\n \"pending_project\": null,\n \"pending_task\": null,\n \"task_id\": null,\n \"service_id\": 3575792,\n \"note\": null,\n \"active\": true,\n \"billable\": false,\n \"billed\": false,\n \"internal\": false,\n \"retainer_id\": null\n },\n {\n \"id\": 47630480,\n \"identity_id\": 1882548,\n \"timer\": null,\n \"is_logged\": true,\n \"started_at\": \"2019-04-18T04:00:00Z\",\n \"created_at\": \"2019-04-18T14:11:34Z\",\n \"duration\": 7200,\n \"client_id\": 31006,\n \"project_id\": 2976412,\n \"pending_client\": null,\n \"pending_project\": null,\n \"pending_task\": null,\n \"task_id\": null,\n \"service_id\": 3575792,\n \"note\": null,\n \"active\": true,\n \"billable\": false,\n \"billed\": false,\n \"internal\": false,\n \"retainer_id\": null\n },\n {\n \"id\": 47630482,\n \"identity_id\": 1882548,\n \"timer\": null,\n \"is_logged\": true,\n \"started_at\": \"2019-04-19T04:00:00Z\",\n \"created_at\": \"2019-04-18T14:11:34Z\",\n \"duration\": 10800,\n \"client_id\": 31006,\n \"project_id\": 2976412,\n \"pending_client\": null,\n \"pending_project\": null,\n \"pending_task\": null,\n \"task_id\": null,\n \"service_id\": 3575792,\n \"note\": null,\n \"active\": true,\n \"billable\": false,\n \"billed\": false,\n \"internal\": false,\n \"retainer_id\": null\n }\n ]\n}"
}
]
}
