Chilkat Online Tools

PowerBuilder / easybill REST API / Fetch projects list

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Name
integer li_Budget_amount
integer li_Budget_time
string ls_Customer_id
string ls_Hourly_rate
string ls_Id
string ls_Login_id
string ls_Note
string ls_Status
string ls_Due_at
string ls_Budget_notify_frequency
string ls_Consumed_time
string ls_Consumed_amount
string ls_Page
string ls_Pages
string ls_Limit
string ls_Total
integer i
integer li_Count_i

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")

loo_QueryParams.UpdateString("limit","<integer>")
loo_QueryParams.UpdateString("page","<integer>")
loo_QueryParams.UpdateString("customer_id","<string>")
loo_QueryParams.UpdateString("status","DONE")

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

loo_Resp = loo_Http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/projects",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_QueryParams
    return
end if

loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

loo_Resp.GetBodySb(loo_SbResponseBody)

loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Resp.Header
    Write-Debug "Failed."
    destroy loo_Resp
    destroy loo_Http
    destroy loo_QueryParams
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

destroy loo_Resp

// 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

ls_Page = loo_JResp.StringOf("page")
ls_Pages = loo_JResp.StringOf("pages")
ls_Limit = loo_JResp.StringOf("limit")
ls_Total = loo_JResp.StringOf("total")
i = 0
li_Count_i = loo_JResp.SizeOfArray("items")
do while i < li_Count_i
    loo_JResp.I = i
    ls_Name = loo_JResp.StringOf("items[i].name")
    li_Budget_amount = loo_JResp.IntOf("items[i].budget_amount")
    li_Budget_time = loo_JResp.IntOf("items[i].budget_time")
    ls_Customer_id = loo_JResp.StringOf("items[i].customer_id")
    ls_Hourly_rate = loo_JResp.StringOf("items[i].hourly_rate")
    ls_Id = loo_JResp.StringOf("items[i].id")
    ls_Login_id = loo_JResp.StringOf("items[i].login_id")
    ls_Note = loo_JResp.StringOf("items[i].note")
    ls_Status = loo_JResp.StringOf("items[i].status")
    ls_Due_at = loo_JResp.StringOf("items[i].due_at")
    ls_Budget_notify_frequency = loo_JResp.StringOf("items[i].budget_notify_frequency")
    ls_Consumed_time = loo_JResp.StringOf("items[i].consumed_time")
    ls_Consumed_amount = loo_JResp.StringOf("items[i].consumed_amount")
    i = i + 1
loop


destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp

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": ""
    }
  ]
}