Chilkat Online Tools

Xojo / easybill REST API / Show a single version 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.

Dim http As New Chilkat.Http
Dim success As Boolean

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

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.easybill.de/rest/v1/documents/:id/versions/:versionId",sbResponseBody)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(http.LastHeader)
    System.DebugLog("Failed.")
    Return
End If

// 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

Dim document_version_item_type As String

Dim created_at As String
created_at = jResp.StringOf("created_at")
Dim document_id As String
document_id = jResp.StringOf("document_id")
Dim id As String
id = jResp.StringOf("id")
Dim reason As String
reason = jResp.StringOf("reason")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("items")
While i < count_i
    jResp.I = i
    document_version_item_type = jResp.StringOf("items[i].document_version_item_type")
    id = jResp.StringOf("items[i].id")
    i = i + 1
Wend

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": ""
    }
  ]
}