PureBasic / easybill REST API / Fetch time trackings list
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkDtObj.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"limit","<integer>")
CkJsonObject::ckUpdateString(queryParams,"page","<integer>")
CkJsonObject::ckUpdateString(queryParams,"login_id","<string>")
CkJsonObject::ckUpdateString(queryParams,"project_id","<string>")
CkJsonObject::ckUpdateString(queryParams,"date_from_at","<string>")
CkJsonObject::ckUpdateString(queryParams,"date_thru_at","<string>")
CkHttp::ckSetRequestHeader(http,"Authorization","{{apiKey}}")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.easybill.de/rest/v1/time-trackings",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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
date_from_at.i = CkDtObj::ckCreate()
If date_from_at.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
date_thru_at.i = CkDtObj::ckCreate()
If date_thru_at.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
description.s
cleared_at.s
created_at.s
hourly_rate.i
id.s
note.s
v_number.s
position_id.s
project_id.s
login_id.s
timer_value.s
page.s = CkJsonObject::ckStringOf(jResp,"page")
pages.s = CkJsonObject::ckStringOf(jResp,"pages")
limit.s = CkJsonObject::ckStringOf(jResp,"limit")
total.s = CkJsonObject::ckStringOf(jResp,"total")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"items")
While i < count_i
CkJsonObject::setCkI(jResp, i)
description = CkJsonObject::ckStringOf(jResp,"items[i].description")
cleared_at = CkJsonObject::ckStringOf(jResp,"items[i].cleared_at")
created_at = CkJsonObject::ckStringOf(jResp,"items[i].created_at")
CkJsonObject::ckDtOf(jResp,"items[i].date_from_at",0,date_from_at)
CkJsonObject::ckDtOf(jResp,"items[i].date_thru_at",0,date_thru_at)
hourly_rate = CkJsonObject::ckIntOf(jResp,"items[i].hourly_rate")
id = CkJsonObject::ckStringOf(jResp,"items[i].id")
note = CkJsonObject::ckStringOf(jResp,"items[i].note")
v_number = CkJsonObject::ckStringOf(jResp,"items[i].number")
position_id = CkJsonObject::ckStringOf(jResp,"items[i].position_id")
project_id = CkJsonObject::ckStringOf(jResp,"items[i].project_id")
login_id = CkJsonObject::ckStringOf(jResp,"items[i].login_id")
timer_value = CkJsonObject::ckStringOf(jResp,"items[i].timer_value")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
CkDtObj::ckDispose(date_from_at)
CkDtObj::ckDispose(date_thru_at)
ProcedureReturn
EndProcedure
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": ""
}
]
}
