delphiDll / easybill REST API / Fetch time trackings list
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
date_from_at: HCkDtObj;
date_thru_at: HCkDtObj;
description: PWideChar;
cleared_at: PWideChar;
created_at: PWideChar;
hourly_rate: Integer;
id: PWideChar;
note: PWideChar;
v_number: PWideChar;
position_id: PWideChar;
project_id: PWideChar;
login_id: PWideChar;
timer_value: PWideChar;
page: PWideChar;
pages: PWideChar;
limit: PWideChar;
total: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
queryParams := CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,'limit','<integer>');
CkJsonObject_UpdateString(queryParams,'page','<integer>');
CkJsonObject_UpdateString(queryParams,'login_id','<string>');
CkJsonObject_UpdateString(queryParams,'project_id','<string>');
CkJsonObject_UpdateString(queryParams,'date_from_at','<string>');
CkJsonObject_UpdateString(queryParams,'date_thru_at','<string>');
CkHttp_SetRequestHeader(http,'Authorization','{{apiKey}}');
CkHttp_SetRequestHeader(http,'Accept','application/json');
resp := CkHttp_QuickRequestParams(http,'GET','https://api.easybill.de/rest/v1/time-trackings',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(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 := CkDtObj_Create();
date_thru_at := CkDtObj_Create();
page := CkJsonObject__stringOf(jResp,'page');
pages := CkJsonObject__stringOf(jResp,'pages');
limit := CkJsonObject__stringOf(jResp,'limit');
total := CkJsonObject__stringOf(jResp,'total');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'items');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
description := CkJsonObject__stringOf(jResp,'items[i].description');
cleared_at := CkJsonObject__stringOf(jResp,'items[i].cleared_at');
created_at := CkJsonObject__stringOf(jResp,'items[i].created_at');
CkJsonObject_DtOf(jResp,'items[i].date_from_at',False,date_from_at);
CkJsonObject_DtOf(jResp,'items[i].date_thru_at',False,date_thru_at);
hourly_rate := CkJsonObject_IntOf(jResp,'items[i].hourly_rate');
id := CkJsonObject__stringOf(jResp,'items[i].id');
note := CkJsonObject__stringOf(jResp,'items[i].note');
v_number := CkJsonObject__stringOf(jResp,'items[i].number');
position_id := CkJsonObject__stringOf(jResp,'items[i].position_id');
project_id := CkJsonObject__stringOf(jResp,'items[i].project_id');
login_id := CkJsonObject__stringOf(jResp,'items[i].login_id');
timer_value := CkJsonObject__stringOf(jResp,'items[i].timer_value');
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
CkDtObj_Dispose(date_from_at);
CkDtObj_Dispose(date_thru_at);
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": ""
}
]
}
