Chilkat Online Tools

Ruby / easybill REST API / Fetch attachments list

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("limit","<integer>")
queryParams.UpdateString("page","<integer>")

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

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/attachments",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# 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

page = jResp.stringOf("page")
pages = jResp.stringOf("pages")
limit = jResp.stringOf("limit")
total = jResp.stringOf("total")
i = 0
count_i = jResp.SizeOfArray("items")
while i < count_i
    jResp.put_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
end

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