Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
Dim queryParams As New Chilkat.JsonObject
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")
Dim resp As Chilkat.HttpResponse = http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/post-boxes",queryParams)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
End If
' 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
Dim id As String
Dim document_id As String
Dim v_to As String
Dim cc As String
Dim from As String
Dim subject As String
Dim message As String
Dim date As String
Dim created_at As String
Dim processed_at As String
Dim send_by_self As String
Dim send_with_attachment As String
Dim v_type As String
Dim status As String
Dim status_msg As String
Dim login_id As String
Dim document_file_type As String
Dim post_send_type As String
Dim tracking_identifier As String
Dim page As String = jResp.StringOf("page")
Dim pages As String = jResp.StringOf("pages")
Dim limit As String = jResp.StringOf("limit")
Dim total As String = jResp.StringOf("total")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("items")
While i < count_i
jResp.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
End While
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": ""
}
]
}
