Chilkat Online Tools

Go / easybill REST API / Fetch post box list

Back to Collection Items

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

    http := chilkat.NewHttp()
    var success bool

    queryParams := chilkat.NewJsonObject()
    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 := http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/post-boxes",queryParams)
    if http.LastMethodSuccess() == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        queryParams.DisposeJsonObject()
        return
    }

    sbResponseBody := chilkat.NewStringBuilder()
    resp.GetBodySb(sbResponseBody)

    jResp := chilkat.NewJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.SetEmitCompact(false)

    fmt.Println("Response Body:")
    fmt.Println(*jResp.Emit())

    respStatusCode := resp.StatusCode()
    fmt.Println("Response Status Code = ", respStatusCode)
    if respStatusCode >= 400 {
        fmt.Println("Response Header:")
        fmt.Println(resp.Header())
        fmt.Println("Failed.")
        resp.DisposeHttpResponse()
        http.DisposeHttp()
        queryParams.DisposeJsonObject()
        sbResponseBody.DisposeStringBuilder()
        jResp.DisposeJsonObject()
        return
    }

    resp.DisposeHttpResponse()

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

    var id *string = new(string)
    var document_id *string = new(string)
    var v_to *string = new(string)
    var cc *string = new(string)
    var from *string = new(string)
    var subject *string = new(string)
    var message *string = new(string)
    var date *string = new(string)
    var created_at *string = new(string)
    var processed_at *string = new(string)
    var send_by_self *string = new(string)
    var send_with_attachment *string = new(string)
    var v_type *string = new(string)
    var status *string = new(string)
    var status_msg *string = new(string)
    var login_id *string = new(string)
    var document_file_type *string = new(string)
    var post_send_type *string = new(string)
    var tracking_identifier *string = new(string)

    page := jResp.StringOf("page")
    pages := jResp.StringOf("pages")
    limit := jResp.StringOf("limit")
    total := jResp.StringOf("total")
    i := 0
    count_i := jResp.SizeOfArray("items")
    for i < count_i {
        jResp.SetI(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
    }


    http.DisposeHttp()
    queryParams.DisposeJsonObject()
    sbResponseBody.DisposeStringBuilder()
    jResp.DisposeJsonObject()

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