TCL / easybill REST API / List all versions of a given document
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "limit" "<integer>"
CkJsonObject_UpdateString $queryParams "page" "<integer>"
CkHttp_SetRequestHeader $http "Authorization" "{{apiKey}}"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://api.easybill.de/rest/v1/documents/:id/versions" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $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
set page [CkJsonObject_stringOf $jResp "page"]
set pages [CkJsonObject_stringOf $jResp "pages"]
set limit [CkJsonObject_stringOf $jResp "limit"]
set total [CkJsonObject_stringOf $jResp "total"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "items"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set created_at [CkJsonObject_stringOf $jResp "items[i].created_at"]
set document_id [CkJsonObject_stringOf $jResp "items[i].document_id"]
set id [CkJsonObject_stringOf $jResp "items[i].id"]
set reason [CkJsonObject_stringOf $jResp "items[i].reason"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "items[i].items"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set document_version_item_type [CkJsonObject_stringOf $jResp "items[i].items[j].document_version_item_type"]
set id [CkJsonObject_stringOf $jResp "items[i].items[j].id"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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": ""
}
]
}
