Back to Collection Items
var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
id: PWideChar;
document_id: PWideChar;
v_to: PWideChar;
cc: PWideChar;
from: PWideChar;
subject: PWideChar;
message: PWideChar;
date: PWideChar;
created_at: PWideChar;
processed_at: PWideChar;
send_by_self: PWideChar;
send_with_attachment: PWideChar;
v_type: PWideChar;
status: PWideChar;
status_msg: PWideChar;
login_id: PWideChar;
document_file_type: PWideChar;
post_send_type: PWideChar;
tracking_identifier: PWideChar;
page: PWideChar;
pages: PWideChar;
limit: PWideChar;
total: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
queryParams := CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,'limit','<integer>');
CkJsonObject_UpdateString(queryParams,'page','<integer>');
CkJsonObject_UpdateString(queryParams,'type','FAX');
CkJsonObject_UpdateString(queryParams,'status','PROCESSING');
CkJsonObject_UpdateString(queryParams,'document_id','<string>');
CkHttp_SetRequestHeader(http,'Authorization','{{apiKey}}');
CkHttp_SetRequestHeader(http,'Accept','application/json');
resp := CkHttp_QuickRequestParams(http,'GET','https://api.easybill.de/rest/v1/post-boxes',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// 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 := CkJsonObject__stringOf(jResp,'page');
pages := CkJsonObject__stringOf(jResp,'pages');
limit := CkJsonObject__stringOf(jResp,'limit');
total := CkJsonObject__stringOf(jResp,'total');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'items');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
id := CkJsonObject__stringOf(jResp,'items[i].id');
document_id := CkJsonObject__stringOf(jResp,'items[i].document_id');
v_to := CkJsonObject__stringOf(jResp,'items[i].to');
cc := CkJsonObject__stringOf(jResp,'items[i].cc');
from := CkJsonObject__stringOf(jResp,'items[i].from');
subject := CkJsonObject__stringOf(jResp,'items[i].subject');
message := CkJsonObject__stringOf(jResp,'items[i].message');
date := CkJsonObject__stringOf(jResp,'items[i].date');
created_at := CkJsonObject__stringOf(jResp,'items[i].created_at');
processed_at := CkJsonObject__stringOf(jResp,'items[i].processed_at');
send_by_self := CkJsonObject__stringOf(jResp,'items[i].send_by_self');
send_with_attachment := CkJsonObject__stringOf(jResp,'items[i].send_with_attachment');
v_type := CkJsonObject__stringOf(jResp,'items[i].type');
status := CkJsonObject__stringOf(jResp,'items[i].status');
status_msg := CkJsonObject__stringOf(jResp,'items[i].status_msg');
login_id := CkJsonObject__stringOf(jResp,'items[i].login_id');
document_file_type := CkJsonObject__stringOf(jResp,'items[i].document_file_type');
post_send_type := CkJsonObject__stringOf(jResp,'items[i].post_send_type');
tracking_identifier := CkJsonObject__stringOf(jResp,'items[i].tracking_identifier');
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
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": ""
}
]
}
