Chilkat Online Tools

Xojo / easybill REST API / Fetch tasks list

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
success = queryParams.UpdateString("limit","<integer>")
success = queryParams.UpdateString("page","<integer>")

http.SetRequestHeader "Authorization","{{apiKey}}"
http.SetRequestHeader "Accept","application/json"

Dim resp As Chilkat.HttpResponse
resp = http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/tasks",queryParams)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
End If

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

// {
//   "page": "<integer>",
//   "pages": "<integer>",
//   "limit": "<integer>",
//   "total": "<integer>",
//   "items": [
//     {
//       "name": "<string>",
//       "status": "CANCEL",
//       "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
//     },
//     {
//       "name": "<string>",
//       "status": "CANCEL",
//       "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

Dim name As String
Dim status As String
Dim category As String
Dim category_custom As String
Dim created_at As String
Dim customer_id As String
Dim description As String
Dim document_id As String
Dim end_at As String
Dim finish_at As String
Dim id As String
Dim login_id As String
Dim position_id As String
Dim priority As String
Dim project_id As String
Dim start_at As String
Dim status_percent As String

Dim page As String
page = jResp.StringOf("page")
Dim pages As String
pages = jResp.StringOf("pages")
Dim limit As String
limit = jResp.StringOf("limit")
Dim total As String
total = jResp.StringOf("total")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("items")
While i < count_i
    jResp.I = i
    name = jResp.StringOf("items[i].name")
    status = jResp.StringOf("items[i].status")
    category = jResp.StringOf("items[i].category")
    category_custom = jResp.StringOf("items[i].category_custom")
    created_at = jResp.StringOf("items[i].created_at")
    customer_id = jResp.StringOf("items[i].customer_id")
    description = jResp.StringOf("items[i].description")
    document_id = jResp.StringOf("items[i].document_id")
    end_at = jResp.StringOf("items[i].end_at")
    finish_at = jResp.StringOf("items[i].finish_at")
    id = jResp.StringOf("items[i].id")
    login_id = jResp.StringOf("items[i].login_id")
    position_id = jResp.StringOf("items[i].position_id")
    priority = jResp.StringOf("items[i].priority")
    project_id = jResp.StringOf("items[i].project_id")
    start_at = jResp.StringOf("items[i].start_at")
    status_percent = jResp.StringOf("items[i].status_percent")
    i = i + 1
Wend

Curl Command

curl -G -d "limit=%3Cinteger%3E"
	-d "page=%3Cinteger%3E"
	-H "Authorization: {{apiKey}}"
	-H "Accept: application/json"
https://api.easybill.de/rest/v1/tasks

Postman Collection Item JSON

{
  "name": "Fetch tasks list",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/tasks?limit=<integer>&page=<integer>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "tasks"
      ],
      "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."
        }
      ]
    }
  },
  "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?limit=<integer>&page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "tasks"
          ],
          "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."
            }
          ]
        }
      },
      "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      \"name\": \"<string>\",\n      \"status\": \"CANCEL\",\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    },\n    {\n      \"name\": \"<string>\",\n      \"status\": \"CANCEL\",\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    }\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}}/tasks?limit=<integer>&page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "tasks"
          ],
          "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."
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}