Chilkat Online Tools

C# / easybill REST API / Fetch task

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

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

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://api.easybill.de/rest/v1/tasks/:id",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("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

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