Chilkat Online Tools

Swift3 / easybill REST API / Fetch projects list

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

    let queryParams = CkoJsonObject()!
    queryParams.update("limit", value: "<integer>")
    queryParams.update("page", value: "<integer>")
    queryParams.update("customer_id", value: "<string>")
    queryParams.update("status", value: "DONE")

    http.setRequestHeader("Authorization", value: "{{apiKey}}")
    http.setRequestHeader("Accept", value: "application/json")

    var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://api.easybill.de/rest/v1/projects", json: queryParams)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    var name: String?
    var budget_amount: Int
    var budget_time: Int
    var customer_id: String?
    var hourly_rate: String?
    var id: String?
    var login_id: String?
    var note: String?
    var status: String?
    var due_at: String?
    var budget_notify_frequency: String?
    var consumed_time: String?
    var consumed_amount: String?

    var page: String? = jResp.string(of: "page")
    var pages: String? = jResp.string(of: "pages")
    var limit: String? = jResp.string(of: "limit")
    var total: String? = jResp.string(of: "total")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "items").intValue
    while i < count_i {
        jResp.i = i
        name = jResp.string(of: "items[i].name")
        budget_amount = jResp.int(of: "items[i].budget_amount").intValue
        budget_time = jResp.int(of: "items[i].budget_time").intValue
        customer_id = jResp.string(of: "items[i].customer_id")
        hourly_rate = jResp.string(of: "items[i].hourly_rate")
        id = jResp.string(of: "items[i].id")
        login_id = jResp.string(of: "items[i].login_id")
        note = jResp.string(of: "items[i].note")
        status = jResp.string(of: "items[i].status")
        due_at = jResp.string(of: "items[i].due_at")
        budget_notify_frequency = jResp.string(of: "items[i].budget_notify_frequency")
        consumed_time = jResp.string(of: "items[i].consumed_time")
        consumed_amount = jResp.string(of: "items[i].consumed_amount")
        i = i + 1
    }


}

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