Chilkat Online Tools

delphiAx / easybill REST API / Fetch attachments list

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
queryParams: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
created_at: WideString;
customer_id: WideString;
document_id: WideString;
file_name: WideString;
id: WideString;
project_id: WideString;
size: WideString;
page: WideString;
pages: WideString;
limit: WideString;
total: WideString;
i: Integer;
count_i: Integer;

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

http := TChilkatHttp.Create(Self);

queryParams := TChilkatJsonObject.Create(Self);
queryParams.UpdateString('limit','<integer>');
queryParams.UpdateString('page','<integer>');

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

resp := http.QuickRequestParams('GET','https://api.easybill.de/rest/v1/attachments',queryParams.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

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

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

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

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

// {
//   "page": "<integer>",
//   "pages": "<integer>",
//   "limit": "<integer>",
//   "total": "<integer>",
//   "items": [
//     {
//       "created_at": "<date>",
//       "customer_id": null,
//       "document_id": null,
//       "file_name": "<string>",
//       "id": "<long>",
//       "project_id": null,
//       "size": "<integer>"
//     },
//     {
//       "created_at": "<date>",
//       "customer_id": null,
//       "document_id": null,
//       "file_name": "<string>",
//       "id": "<long>",
//       "project_id": null,
//       "size": "<integer>"
//     }
//   ]
// }

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

page := jResp.StringOf('page');
pages := jResp.StringOf('pages');
limit := jResp.StringOf('limit');
total := jResp.StringOf('total');
i := 0;
count_i := jResp.SizeOfArray('items');
while i < count_i do
  begin
    jResp.I := i;
    created_at := jResp.StringOf('items[i].created_at');
    customer_id := jResp.StringOf('items[i].customer_id');
    document_id := jResp.StringOf('items[i].document_id');
    file_name := jResp.StringOf('items[i].file_name');
    id := jResp.StringOf('items[i].id');
    project_id := jResp.StringOf('items[i].project_id');
    size := jResp.StringOf('items[i].size');
    i := i + 1;
  end;

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

Postman Collection Item JSON

{
  "name": "Fetch attachments list",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/attachments?limit=<integer>&page=<integer>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "attachments"
      ],
      "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}}/attachments?limit=<integer>&page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "attachments"
          ],
          "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      \"created_at\": \"<date>\",\n      \"customer_id\": null,\n      \"document_id\": null,\n      \"file_name\": \"<string>\",\n      \"id\": \"<long>\",\n      \"project_id\": null,\n      \"size\": \"<integer>\"\n    },\n    {\n      \"created_at\": \"<date>\",\n      \"customer_id\": null,\n      \"document_id\": null,\n      \"file_name\": \"<string>\",\n      \"id\": \"<long>\",\n      \"project_id\": null,\n      \"size\": \"<integer>\"\n    }\n  ]\n}"
    }
  ]
}