Chilkat Online Tools

delphiAx / easybill REST API / Fetch post box

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
id: WideString;
document_id: WideString;
v_to: WideString;
cc: WideString;
from: WideString;
subject: WideString;
message: WideString;
date: WideString;
created_at: WideString;
processed_at: WideString;
send_by_self: WideString;
send_with_attachment: WideString;
v_type: WideString;
status: WideString;
status_msg: WideString;
login_id: WideString;
document_file_type: WideString;
post_send_type: WideString;
tracking_identifier: WideString;

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

http := TChilkatHttp.Create(Self);

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

sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://api.easybill.de/rest/v1/post-boxes/:id',sbResponseBody.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

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

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

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

// {
//   "id": "<long>",
//   "document_id": "<long>",
//   "to": "<string>",
//   "cc": "<string>",
//   "from": "<string>",
//   "subject": "<string>",
//   "message": "<string>",
//   "date": "<date>",
//   "created_at": "<dateTime>",
//   "processed_at": "<dateTime>",
//   "send_by_self": "<boolean>",
//   "send_with_attachment": "<boolean>",
//   "type": "EMAIL",
//   "status": "PROCESSING",
//   "status_msg": "<string>",
//   "login_id": "<long>",
//   "document_file_type": "default",
//   "post_send_type": "post_send_type_registered",
//   "tracking_identifier": "<string>"
// }

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

id := jResp.StringOf('id');
document_id := jResp.StringOf('document_id');
v_to := jResp.StringOf('to');
cc := jResp.StringOf('cc');
from := jResp.StringOf('from');
subject := jResp.StringOf('subject');
message := jResp.StringOf('message');
date := jResp.StringOf('date');
created_at := jResp.StringOf('created_at');
processed_at := jResp.StringOf('processed_at');
send_by_self := jResp.StringOf('send_by_self');
send_with_attachment := jResp.StringOf('send_with_attachment');
v_type := jResp.StringOf('type');
status := jResp.StringOf('status');
status_msg := jResp.StringOf('status_msg');
login_id := jResp.StringOf('login_id');
document_file_type := jResp.StringOf('document_file_type');
post_send_type := jResp.StringOf('post_send_type');
tracking_identifier := jResp.StringOf('tracking_identifier');

Curl Command

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

Postman Collection Item JSON

{
  "name": "Fetch post box",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/post-boxes/:id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "post-boxes",
        ":id"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of post box"
        }
      ]
    }
  },
  "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}}/post-boxes/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "post-boxes",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"id\": \"<long>\",\n  \"document_id\": \"<long>\",\n  \"to\": \"<string>\",\n  \"cc\": \"<string>\",\n  \"from\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"message\": \"<string>\",\n  \"date\": \"<date>\",\n  \"created_at\": \"<dateTime>\",\n  \"processed_at\": \"<dateTime>\",\n  \"send_by_self\": \"<boolean>\",\n  \"send_with_attachment\": \"<boolean>\",\n  \"type\": \"EMAIL\",\n  \"status\": \"PROCESSING\",\n  \"status_msg\": \"<string>\",\n  \"login_id\": \"<long>\",\n  \"document_file_type\": \"default\",\n  \"post_send_type\": \"post_send_type_registered\",\n  \"tracking_identifier\": \"<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}}/post-boxes/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "post-boxes",
            ":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}}/post-boxes/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "post-boxes",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}