Chilkat Online Tools

Swift / easybill REST API / Fetch attachments 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.UpdateString("limit", value: "<integer>")
    queryParams.UpdateString("page", value: "<integer>")

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

    var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://api.easybill.de/rest/v1/attachments", 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": [
    //     {
    //       "created_at": "<date>",
    //       "customer_id": null,
    //       "document_id": null,
    //       "file_name": "<string>",
    //       "id": "<long>",
    //       "project_id": null,
    //       "size": "<integer>"
    //     },
    //     {
    //       "created_at": "<date>",
    //       "customer_id": null,
    //       "document_id": null,
    //       "file_name": "<string>",
    //       "id": "<long>",
    //       "project_id": null,
    //       "size": "<integer>"
    //     }
    //   ]
    // }

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

    var created_at: String?
    var customer_id: String?
    var document_id: String?
    var file_name: String?
    var id: String?
    var project_id: String?
    var size: String?

    var page: String? = jResp.StringOf("page")
    var pages: String? = jResp.StringOf("pages")
    var limit: String? = jResp.StringOf("limit")
    var total: String? = jResp.StringOf("total")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("items").intValue
    while i < count_i {
        jResp.I = i
        created_at = jResp.StringOf("items[i].created_at")
        customer_id = jResp.StringOf("items[i].customer_id")
        document_id = jResp.StringOf("items[i].document_id")
        file_name = jResp.StringOf("items[i].file_name")
        id = jResp.StringOf("items[i].id")
        project_id = jResp.StringOf("items[i].project_id")
        size = jResp.StringOf("items[i].size")
        i = i + 1
    }


}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Fetch attachments list",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/attachments?limit=<integer>&page=<integer>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "attachments"
      ],
      "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."
        }
      ]
    }
  },
  "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}}/attachments?limit=<integer>&page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "attachments"
          ],
          "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."
            }
          ]
        }
      },
      "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      \"created_at\": \"<date>\",\n      \"customer_id\": null,\n      \"document_id\": null,\n      \"file_name\": \"<string>\",\n      \"id\": \"<long>\",\n      \"project_id\": null,\n      \"size\": \"<integer>\"\n    },\n    {\n      \"created_at\": \"<date>\",\n      \"customer_id\": null,\n      \"document_id\": null,\n      \"file_name\": \"<string>\",\n      \"id\": \"<long>\",\n      \"project_id\": null,\n      \"size\": \"<integer>\"\n    }\n  ]\n}"
    }
  ]
}