Chilkat Online Tools

delphiAx / easybill REST API / Fetch task

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
name: WideString;
status: WideString;
category: WideString;
category_custom: WideString;
created_at: WideString;
customer_id: WideString;
description: WideString;
document_id: WideString;
end_at: WideString;
finish_at: WideString;
id: WideString;
login_id: WideString;
position_id: WideString;
priority: WideString;
project_id: WideString;
start_at: WideString;
status_percent: WideString;

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

http := TChilkatHttp.Create(Self);

http.SetRequestHeader('Authorization','{{apiKey}}');
http.SetRequestHeader('Accept','application/json');

sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://api.easybill.de/rest/v1/tasks/:id',sbResponseBody.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := http.LastStatus;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(http.LastHeader);
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

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

name := jResp.StringOf('name');
status := jResp.StringOf('status');
category := jResp.StringOf('category');
category_custom := jResp.StringOf('category_custom');
created_at := jResp.StringOf('created_at');
customer_id := jResp.StringOf('customer_id');
description := jResp.StringOf('description');
document_id := jResp.StringOf('document_id');
end_at := jResp.StringOf('end_at');
finish_at := jResp.StringOf('finish_at');
id := jResp.StringOf('id');
login_id := jResp.StringOf('login_id');
position_id := jResp.StringOf('position_id');
priority := jResp.StringOf('priority');
project_id := jResp.StringOf('project_id');
start_at := jResp.StringOf('start_at');
status_percent := jResp.StringOf('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": ""
    }
  ]
}