Chilkat Online Tools

C / easybill REST API / Fetch attachments list

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject queryParams;
    HCkHttpResponse resp;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *created_at;
    const char *customer_id;
    const char *document_id;
    const char *file_name;
    const char *id;
    const char *project_id;
    const char *size;
    const char *page;
    const char *pages;
    const char *limit;
    const char *total;
    int i;
    int count_i;

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

    http = CkHttp_Create();

    queryParams = CkJsonObject_Create();
    CkJsonObject_UpdateString(queryParams,"limit","<integer>");
    CkJsonObject_UpdateString(queryParams,"page","<integer>");

    CkHttp_SetRequestHeader(http,"Authorization","{{apiKey}}");
    CkHttp_SetRequestHeader(http,"Accept","application/json");

    resp = CkHttp_QuickRequestParams(http,"GET","https://api.easybill.de/rest/v1/attachments",queryParams);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(queryParams);
        return;
    }

    sbResponseBody = CkStringBuilder_Create();
    CkHttpResponse_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttpResponse_getStatusCode(resp);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttpResponse_header(resp));
        printf("Failed.\n");
        CkHttpResponse_Dispose(resp);
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(queryParams);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    CkHttpResponse_Dispose(resp);

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    page = CkJsonObject_stringOf(jResp,"page");
    pages = CkJsonObject_stringOf(jResp,"pages");
    limit = CkJsonObject_stringOf(jResp,"limit");
    total = CkJsonObject_stringOf(jResp,"total");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"items");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        created_at = CkJsonObject_stringOf(jResp,"items[i].created_at");
        customer_id = CkJsonObject_stringOf(jResp,"items[i].customer_id");
        document_id = CkJsonObject_stringOf(jResp,"items[i].document_id");
        file_name = CkJsonObject_stringOf(jResp,"items[i].file_name");
        id = CkJsonObject_stringOf(jResp,"items[i].id");
        project_id = CkJsonObject_stringOf(jResp,"items[i].project_id");
        size = CkJsonObject_stringOf(jResp,"items[i].size");
        i = i + 1;
    }



    CkHttp_Dispose(http);
    CkJsonObject_Dispose(queryParams);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

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