Chilkat Online Tools

Swift3 / easybill REST API / Fetch post box

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

    http.setRequestHeader("Authorization", value: "{{apiKey}}")
    http.setRequestHeader("Accept", value: "application/json")

    let sbResponseBody = CkoStringBuilder()!
    success = http.quickGetSb("https://api.easybill.de/rest/v1/post-boxes/:id", sbContent: sbResponseBody)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = http.lastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.lastHeader!)")
        print("Failed.")
        return
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "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": "EMAIL",
    //   "status": "PROCESSING",
    //   "status_msg": "<string>",
    //   "login_id": "<long>",
    //   "document_file_type": "default",
    //   "post_send_type": "post_send_type_registered",
    //   "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? = jResp.string(of: "id")
    var document_id: String? = jResp.string(of: "document_id")
    var v_to: String? = jResp.string(of: "to")
    var cc: String? = jResp.string(of: "cc")
    var from: String? = jResp.string(of: "from")
    var subject: String? = jResp.string(of: "subject")
    var message: String? = jResp.string(of: "message")
    var date: String? = jResp.string(of: "date")
    var created_at: String? = jResp.string(of: "created_at")
    var processed_at: String? = jResp.string(of: "processed_at")
    var send_by_self: String? = jResp.string(of: "send_by_self")
    var send_with_attachment: String? = jResp.string(of: "send_with_attachment")
    var v_type: String? = jResp.string(of: "type")
    var status: String? = jResp.string(of: "status")
    var status_msg: String? = jResp.string(of: "status_msg")
    var login_id: String? = jResp.string(of: "login_id")
    var document_file_type: String? = jResp.string(of: "document_file_type")
    var post_send_type: String? = jResp.string(of: "post_send_type")
    var tracking_identifier: String? = jResp.string(of: "tracking_identifier")

}

Curl Command

curl -X GET
	-H "Authorization: {{apiKey}}"
	-H "Accept: application/json"
https://api.easybill.de/rest/v1/post-boxes/:id

Postman Collection Item JSON

{
  "name": "Fetch post box",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/post-boxes/:id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "post-boxes",
        ":id"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of post box"
        }
      ]
    }
  },
  "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/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "post-boxes",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\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\": \"EMAIL\",\n  \"status\": \"PROCESSING\",\n  \"status_msg\": \"<string>\",\n  \"login_id\": \"<long>\",\n  \"document_file_type\": \"default\",\n  \"post_send_type\": \"post_send_type_registered\",\n  \"tracking_identifier\": \"<string>\"\n}"
    },
    {
      "name": "Not found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/post-boxes/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "post-boxes",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "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/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "post-boxes",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}