Chilkat Online Tools

Foxpro / easybill REST API / Fetch time trackings list

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL loDate_from_at
LOCAL loDate_thru_at
LOCAL lcDescription
LOCAL lcCleared_at
LOCAL lcCreated_at
LOCAL lnHourly_rate
LOCAL lcId
LOCAL lcNote
LOCAL lcV_number
LOCAL lcPosition_id
LOCAL lcProject_id
LOCAL lcLogin_id
LOCAL lcTimer_value
LOCAL lcPage
LOCAL lcPages
LOCAL lcLimit
LOCAL lcTotal
LOCAL i
LOCAL lnCount_i

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("limit","<integer>")
loQueryParams.UpdateString("page","<integer>")
loQueryParams.UpdateString("login_id","<string>")
loQueryParams.UpdateString("project_id","<string>")
loQueryParams.UpdateString("date_from_at","<string>")
loQueryParams.UpdateString("date_thru_at","<string>")

loHttp.SetRequestHeader("Authorization","{{apiKey}}")
loHttp.SetRequestHeader("Accept","application/json")

loResp = loHttp.QuickRequestParams("GET","https://api.easybill.de/rest/v1/time-trackings",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loQueryParams
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loQueryParams
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* 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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.DtObj')
loDate_from_at = CreateObject('Chilkat.DtObj')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.DtObj')
loDate_thru_at = CreateObject('Chilkat.DtObj')

lcPage = loJResp.StringOf("page")
lcPages = loJResp.StringOf("pages")
lcLimit = loJResp.StringOf("limit")
lcTotal = loJResp.StringOf("total")
i = 0
lnCount_i = loJResp.SizeOfArray("items")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcDescription = loJResp.StringOf("items[i].description")
    lcCleared_at = loJResp.StringOf("items[i].cleared_at")
    lcCreated_at = loJResp.StringOf("items[i].created_at")
    loJResp.DtOf("items[i].date_from_at",0,loDate_from_at)
    loJResp.DtOf("items[i].date_thru_at",0,loDate_thru_at)
    lnHourly_rate = loJResp.IntOf("items[i].hourly_rate")
    lcId = loJResp.StringOf("items[i].id")
    lcNote = loJResp.StringOf("items[i].note")
    lcV_number = loJResp.StringOf("items[i].number")
    lcPosition_id = loJResp.StringOf("items[i].position_id")
    lcProject_id = loJResp.StringOf("items[i].project_id")
    lcLogin_id = loJResp.StringOf("items[i].login_id")
    lcTimer_value = loJResp.StringOf("items[i].timer_value")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
RELEASE loDate_from_at
RELEASE loDate_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": ""
    }
  ]
}