Chilkat Online Tools

TCL / easybill REST API / Fetch time trackings list

Back to Collection Items

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

set queryParams [new_CkJsonObject]

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 is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://api.easybill.de/rest/v1/time-trackings" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $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

set date_from_at [new_CkDtObj]

set date_thru_at [new_CkDtObj]

set page [CkJsonObject_stringOf $jResp "page"]
set pages [CkJsonObject_stringOf $jResp "pages"]
set limit [CkJsonObject_stringOf $jResp "limit"]
set total [CkJsonObject_stringOf $jResp "total"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "items"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set description [CkJsonObject_stringOf $jResp "items[i].description"]
    set cleared_at [CkJsonObject_stringOf $jResp "items[i].cleared_at"]
    set created_at [CkJsonObject_stringOf $jResp "items[i].created_at"]
    CkJsonObject_DtOf $jResp "items[i].date_from_at" 0 $date_from_at
    CkJsonObject_DtOf $jResp "items[i].date_thru_at" 0 $date_thru_at
    set hourly_rate [CkJsonObject_IntOf $jResp "items[i].hourly_rate"]
    set id [CkJsonObject_stringOf $jResp "items[i].id"]
    set note [CkJsonObject_stringOf $jResp "items[i].note"]
    set v_number [CkJsonObject_stringOf $jResp "items[i].number"]
    set position_id [CkJsonObject_stringOf $jResp "items[i].position_id"]
    set project_id [CkJsonObject_stringOf $jResp "items[i].project_id"]
    set login_id [CkJsonObject_stringOf $jResp "items[i].login_id"]
    set timer_value [CkJsonObject_stringOf $jResp "items[i].timer_value"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
delete_CkDtObj $date_from_at
delete_CkDtObj $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": ""
    }
  ]
}