Chilkat Online Tools

lianja / easybill REST API / Fetch projects list

Back to Collection Items

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

loHttp = createobject("CkHttp")

loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("limit","<integer>")
loQueryParams.UpdateString("page","<integer>")
loQueryParams.UpdateString("customer_id","<string>")
loQueryParams.UpdateString("status","DONE")

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

loResp = loHttp.QuickRequestParams("GET","https://api.easybill.de/rest/v1/projects",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loQueryParams
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "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
    return
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": [
//     {
//       "name": "<string>",
//       "budget_amount": 0,
//       "budget_time": 0,
//       "customer_id": null,
//       "hourly_rate": "<float>",
//       "id": "<long>",
//       "login_id": "<long>",
//       "note": null,
//       "status": "OPEN",
//       "due_at": null,
//       "budget_notify_frequency": "ALWAYS",
//       "consumed_time": "<integer>",
//       "consumed_amount": "<integer>"
//     },
//     {
//       "name": "<string>",
//       "budget_amount": 0,
//       "budget_time": 0,
//       "customer_id": null,
//       "hourly_rate": "<float>",
//       "id": "<long>",
//       "login_id": "<long>",
//       "note": null,
//       "status": "OPEN",
//       "due_at": null,
//       "budget_notify_frequency": "ALWAYS",
//       "consumed_time": "<integer>",
//       "consumed_amount": "<integer>"
//     }
//   ]
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

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
    lcName = loJResp.StringOf("items[i].name")
    lnBudget_amount = loJResp.IntOf("items[i].budget_amount")
    lnBudget_time = loJResp.IntOf("items[i].budget_time")
    lcCustomer_id = loJResp.StringOf("items[i].customer_id")
    lcHourly_rate = loJResp.StringOf("items[i].hourly_rate")
    lcId = loJResp.StringOf("items[i].id")
    lcLogin_id = loJResp.StringOf("items[i].login_id")
    lcNote = loJResp.StringOf("items[i].note")
    lcStatus = loJResp.StringOf("items[i].status")
    lcDue_at = loJResp.StringOf("items[i].due_at")
    lcBudget_notify_frequency = loJResp.StringOf("items[i].budget_notify_frequency")
    lcConsumed_time = loJResp.StringOf("items[i].consumed_time")
    lcConsumed_amount = loJResp.StringOf("items[i].consumed_amount")
    i = i + 1
enddo


release loHttp
release loQueryParams
release loSbResponseBody
release loJResp

Curl Command

curl -G -d "limit=%3Cinteger%3E"
	-d "page=%3Cinteger%3E"
	-d "customer_id=%3Cstring%3E"
	-d "status=DONE"
	-H "Authorization: {{apiKey}}"
	-H "Accept: application/json"
https://api.easybill.de/rest/v1/projects

Postman Collection Item JSON

{
  "name": "Fetch projects list",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/projects?limit=<integer>&page=<integer>&customer_id=<string>&status=DONE",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "projects"
      ],
      "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": "customer_id",
          "value": "<string>",
          "description": "Filter projects by customer_id. You can add multiple ids separate by comma like id,id,id."
        },
        {
          "key": "status",
          "value": "DONE",
          "description": "Filter projects by status."
        }
      ]
    }
  },
  "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}}/projects?limit=<integer>&page=<integer>&customer_id=<string>&status=DONE",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "projects"
          ],
          "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": "customer_id",
              "value": "<string>",
              "description": "Filter projects by customer_id. You can add multiple ids separate by comma like id,id,id."
            },
            {
              "key": "status",
              "value": "DONE",
              "description": "Filter projects by status."
            }
          ]
        }
      },
      "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      \"name\": \"<string>\",\n      \"budget_amount\": 0,\n      \"budget_time\": 0,\n      \"customer_id\": null,\n      \"hourly_rate\": \"<float>\",\n      \"id\": \"<long>\",\n      \"login_id\": \"<long>\",\n      \"note\": null,\n      \"status\": \"OPEN\",\n      \"due_at\": null,\n      \"budget_notify_frequency\": \"ALWAYS\",\n      \"consumed_time\": \"<integer>\",\n      \"consumed_amount\": \"<integer>\"\n    },\n    {\n      \"name\": \"<string>\",\n      \"budget_amount\": 0,\n      \"budget_time\": 0,\n      \"customer_id\": null,\n      \"hourly_rate\": \"<float>\",\n      \"id\": \"<long>\",\n      \"login_id\": \"<long>\",\n      \"note\": null,\n      \"status\": \"OPEN\",\n      \"due_at\": null,\n      \"budget_notify_frequency\": \"ALWAYS\",\n      \"consumed_time\": \"<integer>\",\n      \"consumed_amount\": \"<integer>\"\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}}/projects?limit=<integer>&page=<integer>&customer_id=<string>&status=DONE",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "projects"
          ],
          "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": "customer_id",
              "value": "<string>",
              "description": "Filter projects by customer_id. You can add multiple ids separate by comma like id,id,id."
            },
            {
              "key": "status",
              "value": "DONE",
              "description": "Filter projects by status."
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}