DataFlex / easybill REST API / Fetch time trackings list
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
Variant vDate_from_at
Handle hoDate_from_at
Variant vDate_thru_at
Handle hoDate_thru_at
String sDescription
String sCleared_at
String sCreated_at
Integer iHourly_rate
String sId
String sNote
String sV_number
String sPosition_id
String sProject_id
String sLogin_id
String sTimer_value
String sPage
String sPages
String sLimit
String sTotal
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// 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
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "limit" "<integer>" To iSuccess
Get ComUpdateString Of hoQueryParams "page" "<integer>" To iSuccess
Get ComUpdateString Of hoQueryParams "login_id" "<string>" To iSuccess
Get ComUpdateString Of hoQueryParams "project_id" "<string>" To iSuccess
Get ComUpdateString Of hoQueryParams "date_from_at" "<string>" To iSuccess
Get ComUpdateString Of hoQueryParams "date_thru_at" "<string>" To iSuccess
Send ComSetRequestHeader To hoHttp "Authorization" "{{apiKey}}"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://api.easybill.de/rest/v1/time-trackings" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
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 ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "page": "<integer>",
// "pages": "<integer>",
// "limit": "<integer>",
// "total": "<integer>",
// "items": [
// {
// "description": "<string>",
// "cleared_at": null,
// "created_at": "<dateTime>",
// "date_from_at": null,
// "date_thru_at": null,
// "hourly_rate": 0,
// "id": "<long>",
// "note": null,
// "number": "<string>",
// "position_id": null,
// "project_id": null,
// "login_id": "<long>",
// "timer_value": null
// },
// {
// "description": "<string>",
// "cleared_at": null,
// "created_at": "<dateTime>",
// "date_from_at": null,
// "date_thru_at": null,
// "hourly_rate": 0,
// "id": "<long>",
// "note": null,
// "number": "<string>",
// "position_id": null,
// "project_id": null,
// "login_id": "<long>",
// "timer_value": null
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get Create (RefClass(cComChilkatDtObj)) To hoDate_from_at
If (Not(IsComObjectCreated(hoDate_from_at))) Begin
Send CreateComObject of hoDate_from_at
End
Get Create (RefClass(cComChilkatDtObj)) To hoDate_thru_at
If (Not(IsComObjectCreated(hoDate_thru_at))) Begin
Send CreateComObject of hoDate_thru_at
End
Get ComStringOf Of hoJResp "page" To sPage
Get ComStringOf Of hoJResp "pages" To sPages
Get ComStringOf Of hoJResp "limit" To sLimit
Get ComStringOf Of hoJResp "total" To sTotal
Move 0 To i
Get ComSizeOfArray Of hoJResp "items" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "items[i].description" To sDescription
Get ComStringOf Of hoJResp "items[i].cleared_at" To sCleared_at
Get ComStringOf Of hoJResp "items[i].created_at" To sCreated_at
Get pvComObject of hoDate_from_at to vDate_from_at
Get ComDtOf Of hoJResp "items[i].date_from_at" False vDate_from_at To iSuccess
Get pvComObject of hoDate_thru_at to vDate_thru_at
Get ComDtOf Of hoJResp "items[i].date_thru_at" False vDate_thru_at To iSuccess
Get ComIntOf Of hoJResp "items[i].hourly_rate" To iHourly_rate
Get ComStringOf Of hoJResp "items[i].id" To sId
Get ComStringOf Of hoJResp "items[i].note" To sNote
Get ComStringOf Of hoJResp "items[i].number" To sV_number
Get ComStringOf Of hoJResp "items[i].position_id" To sPosition_id
Get ComStringOf Of hoJResp "items[i].project_id" To sProject_id
Get ComStringOf Of hoJResp "items[i].login_id" To sLogin_id
Get ComStringOf Of hoJResp "items[i].timer_value" To sTimer_value
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -G -d "limit=%3Cinteger%3E"
-d "page=%3Cinteger%3E"
-d "login_id=%3Cstring%3E"
-d "project_id=%3Cstring%3E"
-d "date_from_at=%3Cstring%3E"
-d "date_thru_at=%3Cstring%3E"
-H "Authorization: {{apiKey}}"
-H "Accept: application/json"
https://api.easybill.de/rest/v1/time-trackings
Postman Collection Item JSON
{
"name": "Fetch time trackings list",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/time-trackings?limit=<integer>&page=<integer>&login_id=<string>&project_id=<string>&date_from_at=<string>&date_thru_at=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"time-trackings"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "login_id",
"value": "<string>",
"description": "Filter time-tracking by login_id. You can add multiple ids separate by comma like id,id,id."
},
{
"key": "project_id",
"value": "<string>",
"description": "Filter time-tracking by project_id. You can add multiple ids separate by comma like id,id,id."
},
{
"key": "date_from_at",
"value": "<string>",
"description": "Filter time-tracking by date_from_at. You can filter one date with date_from_at=2014-12-10 or between like 2015-01-01,2015-12-31.\nYou can also specify a specific time with date_from_at=2014-12-10 12:30:00 or between like 2015-01-01 12:30:00,2015-01-01 13:00:00."
},
{
"key": "date_thru_at",
"value": "<string>",
"description": "Filter time-tracking by date_thru_at. You can filter one date with date_thru_at=2014-12-10 or between like 2015-01-01,2015-12-31.\nYou can also specify a specific time with date_thru_at=2014-12-10 12:30:00 or between like 2015-01-01 12:30:00,2015-01-01 13:00:00."
}
]
}
},
"response": [
{
"name": "Successful operation",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/time-trackings?limit=<integer>&page=<integer>&login_id=<string>&project_id=<string>&date_from_at=<string>&date_thru_at=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"time-trackings"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "login_id",
"value": "<string>",
"description": "Filter time-tracking by login_id. You can add multiple ids separate by comma like id,id,id."
},
{
"key": "project_id",
"value": "<string>",
"description": "Filter time-tracking by project_id. You can add multiple ids separate by comma like id,id,id."
},
{
"key": "date_from_at",
"value": "<string>",
"description": "Filter time-tracking by date_from_at. You can filter one date with date_from_at=2014-12-10 or between like 2015-01-01,2015-12-31.\nYou can also specify a specific time with date_from_at=2014-12-10 12:30:00 or between like 2015-01-01 12:30:00,2015-01-01 13:00:00."
},
{
"key": "date_thru_at",
"value": "<string>",
"description": "Filter time-tracking by date_thru_at. You can filter one date with date_thru_at=2014-12-10 or between like 2015-01-01,2015-12-31.\nYou can also specify a specific time with date_thru_at=2014-12-10 12:30:00 or between like 2015-01-01 12:30:00,2015-01-01 13:00:00."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"page\": \"<integer>\",\n \"pages\": \"<integer>\",\n \"limit\": \"<integer>\",\n \"total\": \"<integer>\",\n \"items\": [\n {\n \"description\": \"<string>\",\n \"cleared_at\": null,\n \"created_at\": \"<dateTime>\",\n \"date_from_at\": null,\n \"date_thru_at\": null,\n \"hourly_rate\": 0,\n \"id\": \"<long>\",\n \"note\": null,\n \"number\": \"<string>\",\n \"position_id\": null,\n \"project_id\": null,\n \"login_id\": \"<long>\",\n \"timer_value\": null\n },\n {\n \"description\": \"<string>\",\n \"cleared_at\": null,\n \"created_at\": \"<dateTime>\",\n \"date_from_at\": null,\n \"date_thru_at\": null,\n \"hourly_rate\": 0,\n \"id\": \"<long>\",\n \"note\": null,\n \"number\": \"<string>\",\n \"position_id\": null,\n \"project_id\": null,\n \"login_id\": \"<long>\",\n \"timer_value\": null\n }\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/time-trackings?limit=<integer>&page=<integer>&login_id=<string>&project_id=<string>&date_from_at=<string>&date_thru_at=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"time-trackings"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "login_id",
"value": "<string>",
"description": "Filter time-tracking by login_id. You can add multiple ids separate by comma like id,id,id."
},
{
"key": "project_id",
"value": "<string>",
"description": "Filter time-tracking by project_id. You can add multiple ids separate by comma like id,id,id."
},
{
"key": "date_from_at",
"value": "<string>",
"description": "Filter time-tracking by date_from_at. You can filter one date with date_from_at=2014-12-10 or between like 2015-01-01,2015-12-31.\nYou can also specify a specific time with date_from_at=2014-12-10 12:30:00 or between like 2015-01-01 12:30:00,2015-01-01 13:00:00."
},
{
"key": "date_thru_at",
"value": "<string>",
"description": "Filter time-tracking by date_thru_at. You can filter one date with date_thru_at=2014-12-10 or between like 2015-01-01,2015-12-31.\nYou can also specify a specific time with date_thru_at=2014-12-10 12:30:00 or between like 2015-01-01 12:30:00,2015-01-01 13:00:00."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
