Chilkat Online Tools

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

Back to Collection Items

import sys
import chilkat2

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

http = chilkat2.Http()

queryParams = chilkat2.JsonObject()
queryParams.UpdateString("limit","<integer>")
queryParams.UpdateString("page","<integer>")

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

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/documents/:id/versions",queryParams)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)

jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

print("Response Body:")
print(jResp.Emit())

respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(resp.Header)
    print("Failed.")

    sys.exit()

# 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

page = jResp.StringOf("page")
pages = jResp.StringOf("pages")
limit = jResp.StringOf("limit")
total = jResp.StringOf("total")
i = 0
count_i = jResp.SizeOfArray("items")
while i < count_i :
    jResp.I = i
    created_at = jResp.StringOf("items[i].created_at")
    document_id = jResp.StringOf("items[i].document_id")
    id = jResp.StringOf("items[i].id")
    reason = jResp.StringOf("items[i].reason")
    j = 0
    count_j = jResp.SizeOfArray("items[i].items")
    while j < count_j :
        jResp.J = j
        document_version_item_type = jResp.StringOf("items[i].items[j].document_version_item_type")
        id = jResp.StringOf("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": ""
    }
  ]
}