Chilkat Online Tools

Perl / easybill REST API / Fetch post box

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/post-boxes/:id",$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)

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