Chilkat Online Tools

Swift3 / easybill REST API / Fetch task

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/tasks/: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)

    // {
    //   "name": "<string>",
    //   "status": "PROCESSING",
    //   "category": null,
    //   "category_custom": null,
    //   "created_at": "<dateTime>",
    //   "customer_id": null,
    //   "description": null,
    //   "document_id": null,
    //   "end_at": "<dateTime>",
    //   "finish_at": "<dateTime>",
    //   "id": "<long>",
    //   "login_id": "<long>",
    //   "position_id": null,
    //   "priority": "NORMAL",
    //   "project_id": null,
    //   "start_at": null,
    //   "status_percent": null
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var name: String? = jResp.string(of: "name")
    var status: String? = jResp.string(of: "status")
    var category: String? = jResp.string(of: "category")
    var category_custom: String? = jResp.string(of: "category_custom")
    var created_at: String? = jResp.string(of: "created_at")
    var customer_id: String? = jResp.string(of: "customer_id")
    var description: String? = jResp.string(of: "description")
    var document_id: String? = jResp.string(of: "document_id")
    var end_at: String? = jResp.string(of: "end_at")
    var finish_at: String? = jResp.string(of: "finish_at")
    var id: String? = jResp.string(of: "id")
    var login_id: String? = jResp.string(of: "login_id")
    var position_id: String? = jResp.string(of: "position_id")
    var priority: String? = jResp.string(of: "priority")
    var project_id: String? = jResp.string(of: "project_id")
    var start_at: String? = jResp.string(of: "start_at")
    var status_percent: String? = jResp.string(of: "status_percent")

}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Fetch task",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/tasks/:id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "tasks",
        ":id"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of task"
        }
      ]
    }
  },
  "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}}/tasks/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "tasks",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"name\": \"<string>\",\n  \"status\": \"PROCESSING\",\n  \"category\": null,\n  \"category_custom\": null,\n  \"created_at\": \"<dateTime>\",\n  \"customer_id\": null,\n  \"description\": null,\n  \"document_id\": null,\n  \"end_at\": \"<dateTime>\",\n  \"finish_at\": \"<dateTime>\",\n  \"id\": \"<long>\",\n  \"login_id\": \"<long>\",\n  \"position_id\": null,\n  \"priority\": \"NORMAL\",\n  \"project_id\": null,\n  \"start_at\": null,\n  \"status_percent\": null\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}}/tasks/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "tasks",
            ":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}}/tasks/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "tasks",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}