Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("limit","<integer>")
$oQueryParams.UpdateString("page","<integer>")
$oQueryParams.UpdateString("type","FAX")
$oQueryParams.UpdateString("status","PROCESSING")
$oQueryParams.UpdateString("document_id","<string>")
$oHttp.SetRequestHeader "Authorization","{{apiKey}}"
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.QuickRequestParams("GET","https://api.easybill.de/rest/v1/post-boxes",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sId
Local $sDocument_id
Local $sV_to
Local $sCc
Local $sFrom
Local $subject
Local $sMessage
Local $sDate
Local $sCreated_at
Local $sProcessed_at
Local $send_by_self
Local $send_with_attachment
Local $sV_type
Local $status
Local $status_msg
Local $sLogin_id
Local $sDocument_file_type
Local $sPost_send_type
Local $sTracking_identifier
Local $sPage = $oJResp.StringOf("page")
Local $sPages = $oJResp.StringOf("pages")
Local $sLimit = $oJResp.StringOf("limit")
Local $sTotal = $oJResp.StringOf("total")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("items")
While $i < $iCount_i
$oJResp.I = $i
$sId = $oJResp.StringOf("items[i].id")
$sDocument_id = $oJResp.StringOf("items[i].document_id")
$sV_to = $oJResp.StringOf("items[i].to")
$sCc = $oJResp.StringOf("items[i].cc")
$sFrom = $oJResp.StringOf("items[i].from")
$subject = $oJResp.StringOf("items[i].subject")
$sMessage = $oJResp.StringOf("items[i].message")
$sDate = $oJResp.StringOf("items[i].date")
$sCreated_at = $oJResp.StringOf("items[i].created_at")
$sProcessed_at = $oJResp.StringOf("items[i].processed_at")
$send_by_self = $oJResp.StringOf("items[i].send_by_self")
$send_with_attachment = $oJResp.StringOf("items[i].send_with_attachment")
$sV_type = $oJResp.StringOf("items[i].type")
$status = $oJResp.StringOf("items[i].status")
$status_msg = $oJResp.StringOf("items[i].status_msg")
$sLogin_id = $oJResp.StringOf("items[i].login_id")
$sDocument_file_type = $oJResp.StringOf("items[i].document_file_type")
$sPost_send_type = $oJResp.StringOf("items[i].post_send_type")
$sTracking_identifier = $oJResp.StringOf("items[i].tracking_identifier")
$i = $i + 1
Wend
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": ""
}
]
}
