Chilkat Online Tools

Perl / easybill REST API / Show a single version of a given document

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

$http->SetRequestHeader("Authorization","{{apiKey}}");
$http->SetRequestHeader("Accept","application/json");

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $http->QuickGetSb("https://api.easybill.de/rest/v1/documents/:id/versions/:versionId",$sbResponseBody);
if ($success == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $http->get_LastStatus();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $http->lastHeader() . "\r\n";
    print "Failed." . "\r\n";
    exit;
}

# 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

$created_at = $jResp->stringOf("created_at");
$document_id = $jResp->stringOf("document_id");
$id = $jResp->stringOf("id");
$reason = $jResp->stringOf("reason");
$i = 0;
$count_i = $jResp->SizeOfArray("items");
while ($i < $count_i) {
    $jResp->put_I($i);
    $document_version_item_type = $jResp->stringOf("items[i].document_version_item_type");
    $id = $jResp->stringOf("items[i].id");
    $i = $i + 1;
}

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