PowerBuilder / easybill REST API / List all versions of a given document
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Created_at
string ls_Document_id
string ls_Id
string ls_Reason
integer j
integer li_Count_j
string ls_Document_version_item_type
string ls_Page
string ls_Pages
string ls_Limit
string ls_Total
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")
loo_QueryParams.UpdateString("limit","<integer>")
loo_QueryParams.UpdateString("page","<integer>")
loo_Http.SetRequestHeader("Authorization","{{apiKey}}")
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = loo_Http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/documents/:id/versions",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_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
ls_Page = loo_JResp.StringOf("page")
ls_Pages = loo_JResp.StringOf("pages")
ls_Limit = loo_JResp.StringOf("limit")
ls_Total = loo_JResp.StringOf("total")
i = 0
li_Count_i = loo_JResp.SizeOfArray("items")
do while i < li_Count_i
loo_JResp.I = i
ls_Created_at = loo_JResp.StringOf("items[i].created_at")
ls_Document_id = loo_JResp.StringOf("items[i].document_id")
ls_Id = loo_JResp.StringOf("items[i].id")
ls_Reason = loo_JResp.StringOf("items[i].reason")
j = 0
li_Count_j = loo_JResp.SizeOfArray("items[i].items")
do while j < li_Count_j
loo_JResp.J = j
ls_Document_version_item_type = loo_JResp.StringOf("items[i].items[j].document_version_item_type")
ls_Id = loo_JResp.StringOf("items[i].items[j].id")
j = j + 1
loop
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_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": ""
}
]
}
