Chilkat Online Tools

PureBasic / easybill REST API / Fetch time tracking

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.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

    CkHttp::ckSetRequestHeader(http,"Authorization","{{apiKey}}")
    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://api.easybill.de/rest/v1/time-trackings/:id",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    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 = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    ; Sample JSON response:
    ; (Sample code for parsing the JSON response is shown below)

    ; {
    ;   "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 = CkJsonObject::ckStringOf(jResp,"description")
    cleared_at.s = CkJsonObject::ckStringOf(jResp,"cleared_at")
    created_at.s = CkJsonObject::ckStringOf(jResp,"created_at")
    CkJsonObject::ckDtOf(jResp,"date_from_at",0,date_from_at)
    CkJsonObject::ckDtOf(jResp,"date_thru_at",0,date_thru_at)
    hourly_rate.i = CkJsonObject::ckIntOf(jResp,"hourly_rate")
    id.s = CkJsonObject::ckStringOf(jResp,"id")
    note.s = CkJsonObject::ckStringOf(jResp,"note")
    v_number.s = CkJsonObject::ckStringOf(jResp,"number")
    position_id.s = CkJsonObject::ckStringOf(jResp,"position_id")
    project_id.s = CkJsonObject::ckStringOf(jResp,"project_id")
    login_id.s = CkJsonObject::ckStringOf(jResp,"login_id")
    timer_value.s = CkJsonObject::ckStringOf(jResp,"timer_value")


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)
    CkDtObj::ckDispose(date_from_at)
    CkDtObj::ckDispose(date_thru_at)


    ProcedureReturn
EndProcedure

Curl Command

curl -X GET
	-H "Authorization: {{apiKey}}"
	-H "Accept: application/json"
https://api.easybill.de/rest/v1/time-trackings/:id

Postman Collection Item JSON

{
  "name": "Fetch time tracking",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/time-trackings/:id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "time-trackings",
        ":id"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of time tracking"
        }
      ]
    }
  },
  "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/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "time-trackings",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\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}"
    },
    {
      "name": "Not found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/time-trackings/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "time-trackings",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "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/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "time-trackings",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}