Chilkat Online Tools

unicodeC / easybill REST API / Show a single version of a given document

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *document_version_item_type;
    const wchar_t *created_at;
    const wchar_t *document_id;
    const wchar_t *id;
    const wchar_t *reason;
    int i;
    int count_i;

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

    http = CkHttpW_Create();

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

    sbResponseBody = CkStringBuilderW_Create();
    success = CkHttpW_QuickGetSb(http,L"https://api.easybill.de/rest/v1/documents/:id/versions/:versionId",sbResponseBody);
    if (success == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

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

    respStatusCode = CkHttpW_getLastStatus(http);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpW_lastHeader(http));
        wprintf(L"Failed.\n");
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

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

    // {
    //   "created_at": "<dateTime>",
    //   "document_id": "<long>",
    //   "id": "<long>",
    //   "items": [
    //     {
    //       "document_version_item_type": "xrechnung3_0_xml",
    //       "id": "<long>"
    //     },
    //     {
    //       "document_version_item_type": "xrechnung2_3_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.

    created_at = CkJsonObjectW_stringOf(jResp,L"created_at");
    document_id = CkJsonObjectW_stringOf(jResp,L"document_id");
    id = CkJsonObjectW_stringOf(jResp,L"id");
    reason = CkJsonObjectW_stringOf(jResp,L"reason");
    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"items");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        document_version_item_type = CkJsonObjectW_stringOf(jResp,L"items[i].document_version_item_type");
        id = CkJsonObjectW_stringOf(jResp,L"items[i].id");
        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }

Curl Command

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

Postman Collection Item JSON

{
  "name": "Show a single version of a given document",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/documents/:id/versions/:versionId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "documents",
        ":id",
        "versions",
        ":versionId"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of document"
        },
        {
          "key": "versionId",
          "value": "<long>",
          "description": "(Required) ID of document version"
        }
      ]
    }
  },
  "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/:versionId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "documents",
            ":id",
            "versions",
            ":versionId"
          ],
          "variable": [
            {
              "key": "id"
            },
            {
              "key": "versionId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"created_at\": \"<dateTime>\",\n  \"document_id\": \"<long>\",\n  \"id\": \"<long>\",\n  \"items\": [\n    {\n      \"document_version_item_type\": \"xrechnung3_0_xml\",\n      \"id\": \"<long>\"\n    },\n    {\n      \"document_version_item_type\": \"xrechnung2_3_xml\",\n      \"id\": \"<long>\"\n    }\n  ],\n  \"reason\": \"<string>\"\n}"
    },
    {
      "name": "Document Version does not exist",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/documents/:id/versions/:versionId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "documents",
            ":id",
            "versions",
            ":versionId"
          ],
          "variable": [
            {
              "key": "id"
            },
            {
              "key": "versionId"
            }
          ]
        }
      },
      "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}}/documents/:id/versions/:versionId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "documents",
            ":id",
            "versions",
            ":versionId"
          ],
          "variable": [
            {
              "key": "id"
            },
            {
              "key": "versionId"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}