lianja / easybill REST API / List all versions of a given document
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("limit","<integer>")
loQueryParams.UpdateString("page","<integer>")
loHttp.SetRequestHeader("Authorization","{{apiKey}}")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://api.easybill.de/rest/v1/documents/:id/versions",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loQueryParams
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
return
endif
release loResp
// 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
lcPage = loJResp.StringOf("page")
lcPages = loJResp.StringOf("pages")
lcLimit = loJResp.StringOf("limit")
lcTotal = loJResp.StringOf("total")
i = 0
lnCount_i = loJResp.SizeOfArray("items")
do while i < lnCount_i
loJResp.I = i
lcCreated_at = loJResp.StringOf("items[i].created_at")
lcDocument_id = loJResp.StringOf("items[i].document_id")
lcId = loJResp.StringOf("items[i].id")
lcReason = loJResp.StringOf("items[i].reason")
j = 0
lnCount_j = loJResp.SizeOfArray("items[i].items")
do while j < lnCount_j
loJResp.J = j
lcDocument_version_item_type = loJResp.StringOf("items[i].items[j].document_version_item_type")
lcId = loJResp.StringOf("items[i].items[j].id")
j = j + 1
enddo
i = i + 1
enddo
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
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": ""
}
]
}