Chilkat Online Tools

unicodeCpp / easybill REST API / List all versions of a given document

Back to Collection Items

#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkHttpResponseW.h>
#include <CkStringBuilderW.h>

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

    CkHttpW http;
    bool success;

    CkJsonObjectW queryParams;
    queryParams.UpdateString(L"limit",L"<integer>");
    queryParams.UpdateString(L"page",L"<integer>");

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

    CkHttpResponseW *resp = http.QuickRequestParams(L"GET",L"https://api.easybill.de/rest/v1/documents/:id/versions",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    CkStringBuilderW sbResponseBody;
    resp->GetBodySb(sbResponseBody);

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

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",jResp.emit());

    int respStatusCode = resp->get_StatusCode();
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",resp->header());
        wprintf(L"Failed.\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": [
    //     {
    //       "created_at": "<dateTime>",
    //       "document_id": "<long>",
    //       "id": "<long>",
    //       "items": [
    //         {
    //           "document_version_item_type": "zugferd1",
    //           "id": "<long>"
    //         },
    //         {
    //           "document_version_item_type": "xrechnung2_3_xml",
    //           "id": "<long>"
    //         }
    //       ],
    //       "reason": "<string>"
    //     },
    //     {
    //       "created_at": "<dateTime>",
    //       "document_id": "<long>",
    //       "id": "<long>",
    //       "items": [
    //         {
    //           "document_version_item_type": "xrechnung2_3_xml",
    //           "id": "<long>"
    //         },
    //         {
    //           "document_version_item_type": "xrechnung3_0_xml",
    //           "id": "<long>"
    //         }
    //       ],
    //       "reason": "<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 wchar_t *created_at = 0;
    const wchar_t *document_id = 0;
    const wchar_t *id = 0;
    const wchar_t *reason = 0;
    int j;
    int count_j;
    const wchar_t *document_version_item_type = 0;

    const wchar_t *page = jResp.stringOf(L"page");
    const wchar_t *pages = jResp.stringOf(L"pages");
    const wchar_t *limit = jResp.stringOf(L"limit");
    const wchar_t *total = jResp.stringOf(L"total");
    int i = 0;
    int count_i = jResp.SizeOfArray(L"items");
    while (i < count_i) {
        jResp.put_I(i);
        created_at = jResp.stringOf(L"items[i].created_at");
        document_id = jResp.stringOf(L"items[i].document_id");
        id = jResp.stringOf(L"items[i].id");
        reason = jResp.stringOf(L"items[i].reason");
        j = 0;
        count_j = jResp.SizeOfArray(L"items[i].items");
        while (j < count_j) {
            jResp.put_J(j);
            document_version_item_type = jResp.stringOf(L"items[i].items[j].document_version_item_type");
            id = jResp.stringOf(L"items[i].items[j].id");
            j = j + 1;
        }

        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/documents/:id/versions

Postman Collection Item JSON

{
  "name": "List all versions of a given document",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/documents/:id/versions?limit=<integer>&page=<integer>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "documents",
        ":id",
        "versions"
      ],
      "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."
        }
      ],
      "variable": [
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of document"
        }
      ]
    }
  },
  "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}}/documents/:id/versions?limit=<integer>&page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "documents",
            ":id",
            "versions"
          ],
          "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."
            }
          ],
          "variable": [
            {
              "key": "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      \"created_at\": \"<dateTime>\",\n      \"document_id\": \"<long>\",\n      \"id\": \"<long>\",\n      \"items\": [\n        {\n          \"document_version_item_type\": \"zugferd1\",\n          \"id\": \"<long>\"\n        },\n        {\n          \"document_version_item_type\": \"xrechnung2_3_xml\",\n          \"id\": \"<long>\"\n        }\n      ],\n      \"reason\": \"<string>\"\n    },\n    {\n      \"created_at\": \"<dateTime>\",\n      \"document_id\": \"<long>\",\n      \"id\": \"<long>\",\n      \"items\": [\n        {\n          \"document_version_item_type\": \"xrechnung2_3_xml\",\n          \"id\": \"<long>\"\n        },\n        {\n          \"document_version_item_type\": \"xrechnung3_0_xml\",\n          \"id\": \"<long>\"\n        }\n      ],\n      \"reason\": \"<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}}/documents/:id/versions?limit=<integer>&page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "documents",
            ":id",
            "versions"
          ],
          "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."
            }
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}