Chilkat Online Tools

DataFlex / easybill REST API / Fetch tasks list

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vQueryParams
    Handle hoQueryParams
    Variant vResp
    Handle hoResp
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sName
    String sStatus
    String sCategory
    String sCategory_custom
    String sCreated_at
    String sCustomer_id
    String sDescription
    String sDocument_id
    String sEnd_at
    String sFinish_at
    String sId
    String sLogin_id
    String sPosition_id
    String sPriority
    String sProject_id
    String sStart_at
    String sStatus_percent
    String sPage
    String sPages
    String sLimit
    String sTotal
    Integer i
    Integer iCount_i
    String sTemp1
    Boolean bTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
    If (Not(IsComObjectCreated(hoQueryParams))) Begin
        Send CreateComObject of hoQueryParams
    End
    Get ComUpdateString Of hoQueryParams "limit" "<integer>" To iSuccess
    Get ComUpdateString Of hoQueryParams "page" "<integer>" To iSuccess

    Send ComSetRequestHeader To hoHttp "Authorization" "{{apiKey}}"
    Send ComSetRequestHeader To hoHttp "Accept" "application/json"

    Get pvComObject of hoQueryParams to vQueryParams
    Get ComQuickRequestParams Of hoHttp "GET" "https://api.easybill.de/rest/v1/tasks" vQueryParams To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess

    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComStatusCode Of hoResp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComHeader Of hoResp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Send Destroy of hoResp
        Procedure_Return
    End

    Send Destroy of hoResp

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

    Get ComStringOf Of hoJResp "page" To sPage
    Get ComStringOf Of hoJResp "pages" To sPages
    Get ComStringOf Of hoJResp "limit" To sLimit
    Get ComStringOf Of hoJResp "total" To sTotal
    Move 0 To i
    Get ComSizeOfArray Of hoJResp "items" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "items[i].name" To sName
        Get ComStringOf Of hoJResp "items[i].status" To sStatus
        Get ComStringOf Of hoJResp "items[i].category" To sCategory
        Get ComStringOf Of hoJResp "items[i].category_custom" To sCategory_custom
        Get ComStringOf Of hoJResp "items[i].created_at" To sCreated_at
        Get ComStringOf Of hoJResp "items[i].customer_id" To sCustomer_id
        Get ComStringOf Of hoJResp "items[i].description" To sDescription
        Get ComStringOf Of hoJResp "items[i].document_id" To sDocument_id
        Get ComStringOf Of hoJResp "items[i].end_at" To sEnd_at
        Get ComStringOf Of hoJResp "items[i].finish_at" To sFinish_at
        Get ComStringOf Of hoJResp "items[i].id" To sId
        Get ComStringOf Of hoJResp "items[i].login_id" To sLogin_id
        Get ComStringOf Of hoJResp "items[i].position_id" To sPosition_id
        Get ComStringOf Of hoJResp "items[i].priority" To sPriority
        Get ComStringOf Of hoJResp "items[i].project_id" To sProject_id
        Get ComStringOf Of hoJResp "items[i].start_at" To sStart_at
        Get ComStringOf Of hoJResp "items[i].status_percent" To sStatus_percent
        Move (i + 1) To i
    Loop



End_Procedure

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