Chilkat Online Tools

phpExt / easybill REST API / Fetch a list of serial numbers for positions

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

$queryParams = new CkJsonObject();
$queryParams->UpdateString('limit','<integer>');
$queryParams->UpdateString('page','<integer>');
$queryParams->UpdateString('position_id','<string>');
$queryParams->UpdateString('document_id','<string>');
$queryParams->UpdateString('in_use','<boolean>');

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

// resp is a CkHttpResponse
$resp = $http->QuickRequestParams('GET','https://api.easybill.de/rest/v1/serial-numbers',$queryParams);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

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

$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->header() . "\n";
    print 'Failed.' . "\n";

    exit;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "page": "<integer>",
//   "pages": "<integer>",
//   "limit": "<integer>",
//   "total": "<integer>",
//   "items": [
//     {
//       "serial_number": "<string>",
//       "position_id": "<integer>",
//       "id": "<long>",
//       "document_id": "<long>",
//       "document_position_id": "<long>",
//       "used_at": "<string>",
//       "created_at": "<string>"
//     },
//     {
//       "serial_number": "<string>",
//       "position_id": "<integer>",
//       "id": "<long>",
//       "document_id": "<long>",
//       "document_position_id": "<long>",
//       "used_at": "<string>",
//       "created_at": "<string>"
//     }
//   ]
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$page = $jResp->stringOf('page');
$pages = $jResp->stringOf('pages');
$limit = $jResp->stringOf('limit');
$total = $jResp->stringOf('total');
$i = 0;
$count_i = $jResp->SizeOfArray('items');
while ($i < $count_i) {
    $jResp->put_I($i);
    $serial_number = $jResp->stringOf('items[i].serial_number');
    $position_id = $jResp->stringOf('items[i].position_id');
    $id = $jResp->stringOf('items[i].id');
    $document_id = $jResp->stringOf('items[i].document_id');
    $document_position_id = $jResp->stringOf('items[i].document_position_id');
    $used_at = $jResp->stringOf('items[i].used_at');
    $created_at = $jResp->stringOf('items[i].created_at');
    $i = $i + 1;
}


?>

Curl Command

curl -G -d "limit=%3Cinteger%3E"
	-d "page=%3Cinteger%3E"
	-d "position_id=%3Cstring%3E"
	-d "document_id=%3Cstring%3E"
	-d "in_use=%3Cboolean%3E"
	-H "Authorization: {{apiKey}}"
	-H "Accept: application/json"
https://api.easybill.de/rest/v1/serial-numbers

Postman Collection Item JSON

{
  "name": "Fetch a list of serial numbers for positions",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/serial-numbers?limit=<integer>&page=<integer>&position_id=<string>&document_id=<string>&in_use=<boolean>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "serial-numbers"
      ],
      "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."
        },
        {
          "key": "position_id",
          "value": "<string>",
          "description": "Filter serial numbers by position id."
        },
        {
          "key": "document_id",
          "value": "<string>",
          "description": "Filter serial numbers by document id."
        },
        {
          "key": "in_use",
          "value": "<boolean>",
          "description": "Filter serial numbers by usage."
        }
      ]
    }
  },
  "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}}/serial-numbers?limit=<integer>&page=<integer>&position_id=<string>&document_id=<string>&in_use=<boolean>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serial-numbers"
          ],
          "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."
            },
            {
              "key": "position_id",
              "value": "<string>",
              "description": "Filter serial numbers by position id."
            },
            {
              "key": "document_id",
              "value": "<string>",
              "description": "Filter serial numbers by document id."
            },
            {
              "key": "in_use",
              "value": "<boolean>",
              "description": "Filter serial numbers by usage."
            }
          ]
        }
      },
      "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      \"serial_number\": \"<string>\",\n      \"position_id\": \"<integer>\",\n      \"id\": \"<long>\",\n      \"document_id\": \"<long>\",\n      \"document_position_id\": \"<long>\",\n      \"used_at\": \"<string>\",\n      \"created_at\": \"<string>\"\n    },\n    {\n      \"serial_number\": \"<string>\",\n      \"position_id\": \"<integer>\",\n      \"id\": \"<long>\",\n      \"document_id\": \"<long>\",\n      \"document_position_id\": \"<long>\",\n      \"used_at\": \"<string>\",\n      \"created_at\": \"<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}}/serial-numbers?limit=<integer>&page=<integer>&position_id=<string>&document_id=<string>&in_use=<boolean>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serial-numbers"
          ],
          "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."
            },
            {
              "key": "position_id",
              "value": "<string>",
              "description": "Filter serial numbers by position id."
            },
            {
              "key": "document_id",
              "value": "<string>",
              "description": "Filter serial numbers by document id."
            },
            {
              "key": "in_use",
              "value": "<boolean>",
              "description": "Filter serial numbers by usage."
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}