Chilkat Online Tools

C++ / easybill REST API / Fetch post box list

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>

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

    CkHttp http;
    bool success;

    CkJsonObject queryParams;
    queryParams.UpdateString("limit","<integer>");
    queryParams.UpdateString("page","<integer>");
    queryParams.UpdateString("type","FAX");
    queryParams.UpdateString("status","PROCESSING");
    queryParams.UpdateString("document_id","<string>");

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

    CkHttpResponse *resp = http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/post-boxes",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete resp;

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "page": "<integer>",
    //   "pages": "<integer>",
    //   "limit": "<integer>",
    //   "total": "<integer>",
    //   "items": [
    //     {
    //       "id": "<long>",
    //       "document_id": "<long>",
    //       "to": "<string>",
    //       "cc": "<string>",
    //       "from": "<string>",
    //       "subject": "<string>",
    //       "message": "<string>",
    //       "date": "<date>",
    //       "created_at": "<dateTime>",
    //       "processed_at": "<dateTime>",
    //       "send_by_self": "<boolean>",
    //       "send_with_attachment": "<boolean>",
    //       "type": "POST",
    //       "status": "WAITING",
    //       "status_msg": "<string>",
    //       "login_id": "<long>",
    //       "document_file_type": "zugferd1",
    //       "post_send_type": "post_send_type_registered_throwin",
    //       "tracking_identifier": "<string>"
    //     },
    //     {
    //       "id": "<long>",
    //       "document_id": "<long>",
    //       "to": "<string>",
    //       "cc": "<string>",
    //       "from": "<string>",
    //       "subject": "<string>",
    //       "message": "<string>",
    //       "date": "<date>",
    //       "created_at": "<dateTime>",
    //       "processed_at": "<dateTime>",
    //       "send_by_self": "<boolean>",
    //       "send_with_attachment": "<boolean>",
    //       "type": "POST",
    //       "status": "OK",
    //       "status_msg": "<string>",
    //       "login_id": "<long>",
    //       "document_file_type": "default",
    //       "post_send_type": "post_send_type_registered_throwin",
    //       "tracking_identifier": "<string>"
    //     }
    //   ]
    // }

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

    const char *id = 0;
    const char *document_id = 0;
    const char *v_to = 0;
    const char *cc = 0;
    const char *from = 0;
    const char *subject = 0;
    const char *message = 0;
    const char *date = 0;
    const char *created_at = 0;
    const char *processed_at = 0;
    const char *send_by_self = 0;
    const char *send_with_attachment = 0;
    const char *v_type = 0;
    const char *status = 0;
    const char *status_msg = 0;
    const char *login_id = 0;
    const char *document_file_type = 0;
    const char *post_send_type = 0;
    const char *tracking_identifier = 0;

    const char *page = jResp.stringOf("page");
    const char *pages = jResp.stringOf("pages");
    const char *limit = jResp.stringOf("limit");
    const char *total = jResp.stringOf("total");
    int i = 0;
    int count_i = jResp.SizeOfArray("items");
    while (i < count_i) {
        jResp.put_I(i);
        id = jResp.stringOf("items[i].id");
        document_id = jResp.stringOf("items[i].document_id");
        v_to = jResp.stringOf("items[i].to");
        cc = jResp.stringOf("items[i].cc");
        from = jResp.stringOf("items[i].from");
        subject = jResp.stringOf("items[i].subject");
        message = jResp.stringOf("items[i].message");
        date = jResp.stringOf("items[i].date");
        created_at = jResp.stringOf("items[i].created_at");
        processed_at = jResp.stringOf("items[i].processed_at");
        send_by_self = jResp.stringOf("items[i].send_by_self");
        send_with_attachment = jResp.stringOf("items[i].send_with_attachment");
        v_type = jResp.stringOf("items[i].type");
        status = jResp.stringOf("items[i].status");
        status_msg = jResp.stringOf("items[i].status_msg");
        login_id = jResp.stringOf("items[i].login_id");
        document_file_type = jResp.stringOf("items[i].document_file_type");
        post_send_type = jResp.stringOf("items[i].post_send_type");
        tracking_identifier = jResp.stringOf("items[i].tracking_identifier");
        i = i + 1;
    }
    }

Curl Command

curl -G -d "limit=%3Cinteger%3E"
	-d "page=%3Cinteger%3E"
	-d "type=FAX"
	-d "status=PROCESSING"
	-d "document_id=%3Cstring%3E"
	-H "Authorization: {{apiKey}}"
	-H "Accept: application/json"
https://api.easybill.de/rest/v1/post-boxes

Postman Collection Item JSON

{
  "name": "Fetch post box list",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/post-boxes?limit=<integer>&page=<integer>&type=FAX&status=PROCESSING&document_id=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "post-boxes"
      ],
      "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": "type",
          "value": "FAX",
          "description": "Filter post boxes by type. Multiple typs seperate with , like type=EMAIL,FAX."
        },
        {
          "key": "status",
          "value": "PROCESSING",
          "description": "Filter post boxes by status."
        },
        {
          "key": "document_id",
          "value": "<string>",
          "description": "Filter post boxes by document_id. You can add multiple document ids separate by comma like id,id,id."
        }
      ]
    }
  },
  "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}}/post-boxes?limit=<integer>&page=<integer>&type=FAX&status=PROCESSING&document_id=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "post-boxes"
          ],
          "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": "type",
              "value": "FAX",
              "description": "Filter post boxes by type. Multiple typs seperate with , like type=EMAIL,FAX."
            },
            {
              "key": "status",
              "value": "PROCESSING",
              "description": "Filter post boxes by status."
            },
            {
              "key": "document_id",
              "value": "<string>",
              "description": "Filter post boxes by document_id. You can add multiple document ids separate by comma like id,id,id."
            }
          ]
        }
      },
      "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      \"id\": \"<long>\",\n      \"document_id\": \"<long>\",\n      \"to\": \"<string>\",\n      \"cc\": \"<string>\",\n      \"from\": \"<string>\",\n      \"subject\": \"<string>\",\n      \"message\": \"<string>\",\n      \"date\": \"<date>\",\n      \"created_at\": \"<dateTime>\",\n      \"processed_at\": \"<dateTime>\",\n      \"send_by_self\": \"<boolean>\",\n      \"send_with_attachment\": \"<boolean>\",\n      \"type\": \"POST\",\n      \"status\": \"WAITING\",\n      \"status_msg\": \"<string>\",\n      \"login_id\": \"<long>\",\n      \"document_file_type\": \"zugferd1\",\n      \"post_send_type\": \"post_send_type_registered_throwin\",\n      \"tracking_identifier\": \"<string>\"\n    },\n    {\n      \"id\": \"<long>\",\n      \"document_id\": \"<long>\",\n      \"to\": \"<string>\",\n      \"cc\": \"<string>\",\n      \"from\": \"<string>\",\n      \"subject\": \"<string>\",\n      \"message\": \"<string>\",\n      \"date\": \"<date>\",\n      \"created_at\": \"<dateTime>\",\n      \"processed_at\": \"<dateTime>\",\n      \"send_by_self\": \"<boolean>\",\n      \"send_with_attachment\": \"<boolean>\",\n      \"type\": \"POST\",\n      \"status\": \"OK\",\n      \"status_msg\": \"<string>\",\n      \"login_id\": \"<long>\",\n      \"document_file_type\": \"default\",\n      \"post_send_type\": \"post_send_type_registered_throwin\",\n      \"tracking_identifier\": \"<string>\"\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}}/post-boxes?limit=<integer>&page=<integer>&type=FAX&status=PROCESSING&document_id=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "post-boxes"
          ],
          "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": "type",
              "value": "FAX",
              "description": "Filter post boxes by type. Multiple typs seperate with , like type=EMAIL,FAX."
            },
            {
              "key": "status",
              "value": "PROCESSING",
              "description": "Filter post boxes by status."
            },
            {
              "key": "document_id",
              "value": "<string>",
              "description": "Filter post boxes by document_id. You can add multiple document ids separate by comma like id,id,id."
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}