Chilkat Online Tools

delphiDll / easybill REST API / Fetch a serial number for a position

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
serial_number: PWideChar;
position_id: PWideChar;
id: PWideChar;
document_id: PWideChar;
document_position_id: PWideChar;
used_at: PWideChar;
created_at: PWideChar;

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

http := CkHttp_Create();

CkHttp_SetRequestHeader(http,'Authorization','{{apiKey}}');
CkHttp_SetRequestHeader(http,'Accept','application/json');

sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://api.easybill.de/rest/v1/serial-numbers/:id',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

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

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

serial_number := CkJsonObject__stringOf(jResp,'serial_number');
position_id := CkJsonObject__stringOf(jResp,'position_id');
id := CkJsonObject__stringOf(jResp,'id');
document_id := CkJsonObject__stringOf(jResp,'document_id');
document_position_id := CkJsonObject__stringOf(jResp,'document_position_id');
used_at := CkJsonObject__stringOf(jResp,'used_at');
created_at := CkJsonObject__stringOf(jResp,'created_at');

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

Curl Command

curl -X GET
	-H "Authorization: {{apiKey}}"
	-H "Accept: application/json"
https://api.easybill.de/rest/v1/serial-numbers/:id

Postman Collection Item JSON

{
  "name": "Fetch a serial number for a position",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/serial-numbers/:id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "serial-numbers",
        ":id"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of the serial number that needs to be fetched"
        }
      ]
    }
  },
  "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/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serial-numbers",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\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}"
    },
    {
      "name": "Not found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/serial-numbers/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serial-numbers",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "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}}/serial-numbers/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serial-numbers",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}