Chilkat Online Tools

lianja / easybill REST API / Fetch post box list

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loHttp = createobject("CkHttp")

loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("limit","<integer>")
loQueryParams.UpdateString("page","<integer>")
loQueryParams.UpdateString("type","FAX")
loQueryParams.UpdateString("status","PROCESSING")
loQueryParams.UpdateString("document_id","<string>")

loHttp.SetRequestHeader("Authorization","{{apiKey}}")
loHttp.SetRequestHeader("Accept","application/json")

loResp = loHttp.QuickRequestParams("GET","https://api.easybill.de/rest/v1/post-boxes",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loQueryParams
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loQueryParams
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

// 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

lcPage = loJResp.StringOf("page")
lcPages = loJResp.StringOf("pages")
lcLimit = loJResp.StringOf("limit")
lcTotal = loJResp.StringOf("total")
i = 0
lnCount_i = loJResp.SizeOfArray("items")
do while i < lnCount_i
    loJResp.I = i
    lcId = loJResp.StringOf("items[i].id")
    lcDocument_id = loJResp.StringOf("items[i].document_id")
    lcV_to = loJResp.StringOf("items[i].to")
    lcCc = loJResp.StringOf("items[i].cc")
    lcFrom = loJResp.StringOf("items[i].from")
    lcSubject = loJResp.StringOf("items[i].subject")
    lcMessage = loJResp.StringOf("items[i].message")
    lcDate = loJResp.StringOf("items[i].date")
    lcCreated_at = loJResp.StringOf("items[i].created_at")
    lcProcessed_at = loJResp.StringOf("items[i].processed_at")
    lcSend_by_self = loJResp.StringOf("items[i].send_by_self")
    lcSend_with_attachment = loJResp.StringOf("items[i].send_with_attachment")
    lcV_type = loJResp.StringOf("items[i].type")
    lcStatus = loJResp.StringOf("items[i].status")
    lcStatus_msg = loJResp.StringOf("items[i].status_msg")
    lcLogin_id = loJResp.StringOf("items[i].login_id")
    lcDocument_file_type = loJResp.StringOf("items[i].document_file_type")
    lcPost_send_type = loJResp.StringOf("items[i].post_send_type")
    lcTracking_identifier = loJResp.StringOf("items[i].tracking_identifier")
    i = i + 1
enddo


release loHttp
release loQueryParams
release loSbResponseBody
release loJResp

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