Chilkat Online Tools

C++ / easybill REST API / Fetch post box

Back to Collection Items

#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.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;

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

    CkStringBuilder sbResponseBody;
    success = http.QuickGetSb("https://api.easybill.de/rest/v1/post-boxes/:id",sbResponseBody);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

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

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

    int respStatusCode = http.get_LastStatus();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << http.lastHeader() << "\r\n";
        std::cout << "Failed." << "\r\n";
        return;
    }

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

    // {
    //   "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": "EMAIL",
    //   "status": "PROCESSING",
    //   "status_msg": "<string>",
    //   "login_id": "<long>",
    //   "document_file_type": "default",
    //   "post_send_type": "post_send_type_registered",
    //   "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 = jResp.stringOf("id");
    const char *document_id = jResp.stringOf("document_id");
    const char *v_to = jResp.stringOf("to");
    const char *cc = jResp.stringOf("cc");
    const char *from = jResp.stringOf("from");
    const char *subject = jResp.stringOf("subject");
    const char *message = jResp.stringOf("message");
    const char *date = jResp.stringOf("date");
    const char *created_at = jResp.stringOf("created_at");
    const char *processed_at = jResp.stringOf("processed_at");
    const char *send_by_self = jResp.stringOf("send_by_self");
    const char *send_with_attachment = jResp.stringOf("send_with_attachment");
    const char *v_type = jResp.stringOf("type");
    const char *status = jResp.stringOf("status");
    const char *status_msg = jResp.stringOf("status_msg");
    const char *login_id = jResp.stringOf("login_id");
    const char *document_file_type = jResp.stringOf("document_file_type");
    const char *post_send_type = jResp.stringOf("post_send_type");
    const char *tracking_identifier = jResp.stringOf("tracking_identifier");
    }

Curl Command

curl -X GET
	-H "Authorization: {{apiKey}}"
	-H "Accept: application/json"
https://api.easybill.de/rest/v1/post-boxes/:id

Postman Collection Item JSON

{
  "name": "Fetch post box",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/post-boxes/:id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "post-boxes",
        ":id"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of post box"
        }
      ]
    }
  },
  "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/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "post-boxes",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\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\": \"EMAIL\",\n  \"status\": \"PROCESSING\",\n  \"status_msg\": \"<string>\",\n  \"login_id\": \"<long>\",\n  \"document_file_type\": \"default\",\n  \"post_send_type\": \"post_send_type_registered\",\n  \"tracking_identifier\": \"<string>\"\n}"
    },
    {
      "name": "Not found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/post-boxes/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "post-boxes",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "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/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "post-boxes",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}