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('type','FAX');
$queryParams->UpdateString('status','PROCESSING');
$queryParams->UpdateString('document_id','<string>');
$http->SetRequestHeader('Authorization','{{apiKey}}');
$http->SetRequestHeader('Accept','application/json');
// resp is a CkHttpResponse
$resp = $http->QuickRequestParams('GET','https://api.easybill.de/rest/v1/post-boxes',$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": [
// {
// "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": "POST",
// "status": "WAITING",
// "status_msg": "<string>",
// "login_id": "<long>",
// "document_file_type": "zugferd1",
// "post_send_type": "post_send_type_registered_throwin",
// "tracking_identifier": "<string>"
// },
// {
// "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": "POST",
// "status": "OK",
// "status_msg": "<string>",
// "login_id": "<long>",
// "document_file_type": "default",
// "post_send_type": "post_send_type_registered_throwin",
// "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
$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);
$id = $jResp->stringOf('items[i].id');
$document_id = $jResp->stringOf('items[i].document_id');
$v_to = $jResp->stringOf('items[i].to');
$cc = $jResp->stringOf('items[i].cc');
$from = $jResp->stringOf('items[i].from');
$subject = $jResp->stringOf('items[i].subject');
$message = $jResp->stringOf('items[i].message');
$date = $jResp->stringOf('items[i].date');
$created_at = $jResp->stringOf('items[i].created_at');
$processed_at = $jResp->stringOf('items[i].processed_at');
$send_by_self = $jResp->stringOf('items[i].send_by_self');
$send_with_attachment = $jResp->stringOf('items[i].send_with_attachment');
$v_type = $jResp->stringOf('items[i].type');
$status = $jResp->stringOf('items[i].status');
$status_msg = $jResp->stringOf('items[i].status_msg');
$login_id = $jResp->stringOf('items[i].login_id');
$document_file_type = $jResp->stringOf('items[i].document_file_type');
$post_send_type = $jResp->stringOf('items[i].post_send_type');
$tracking_identifier = $jResp->stringOf('items[i].tracking_identifier');
$i = $i + 1;
}
?>
Curl Command
curl -G -d "limit=%3Cinteger%3E"
-d "page=%3Cinteger%3E"
-d "type=FAX"
-d "status=PROCESSING"
-d "document_id=%3Cstring%3E"
-H "Authorization: {{apiKey}}"
-H "Accept: application/json"
https://api.easybill.de/rest/v1/post-boxes
Postman Collection Item JSON
{
"name": "Fetch post box list",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/post-boxes?limit=<integer>&page=<integer>&type=FAX&status=PROCESSING&document_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"post-boxes"
],
"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": "type",
"value": "FAX",
"description": "Filter post boxes by type. Multiple typs seperate with , like type=EMAIL,FAX."
},
{
"key": "status",
"value": "PROCESSING",
"description": "Filter post boxes by status."
},
{
"key": "document_id",
"value": "<string>",
"description": "Filter post boxes by document_id. You can add multiple document ids separate by comma like id,id,id."
}
]
}
},
"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?limit=<integer>&page=<integer>&type=FAX&status=PROCESSING&document_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"post-boxes"
],
"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": "type",
"value": "FAX",
"description": "Filter post boxes by type. Multiple typs seperate with , like type=EMAIL,FAX."
},
{
"key": "status",
"value": "PROCESSING",
"description": "Filter post boxes by status."
},
{
"key": "document_id",
"value": "<string>",
"description": "Filter post boxes by document_id. You can add multiple document ids separate by comma like id,id,id."
}
]
}
},
"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 \"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\": \"POST\",\n \"status\": \"WAITING\",\n \"status_msg\": \"<string>\",\n \"login_id\": \"<long>\",\n \"document_file_type\": \"zugferd1\",\n \"post_send_type\": \"post_send_type_registered_throwin\",\n \"tracking_identifier\": \"<string>\"\n },\n {\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\": \"POST\",\n \"status\": \"OK\",\n \"status_msg\": \"<string>\",\n \"login_id\": \"<long>\",\n \"document_file_type\": \"default\",\n \"post_send_type\": \"post_send_type_registered_throwin\",\n \"tracking_identifier\": \"<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}}/post-boxes?limit=<integer>&page=<integer>&type=FAX&status=PROCESSING&document_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"post-boxes"
],
"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": "type",
"value": "FAX",
"description": "Filter post boxes by type. Multiple typs seperate with , like type=EMAIL,FAX."
},
{
"key": "status",
"value": "PROCESSING",
"description": "Filter post boxes by status."
},
{
"key": "document_id",
"value": "<string>",
"description": "Filter post boxes by document_id. You can add multiple document ids separate by comma like id,id,id."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
