Chilkat Online Tools

delphiDll / easybill REST API / Fetch customer contact list

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
city: PWideChar;
street: PWideChar;
state: PWideChar;
company_name: PWideChar;
country: PWideChar;
department: PWideChar;
fax: PWideChar;
first_name: PWideChar;
id: PWideChar;
last_name: PWideChar;
login_id: PWideChar;
mobile: PWideChar;
note: PWideChar;
personal: Boolean;
phone_1: PWideChar;
phone_2: PWideChar;
salutation: PWideChar;
suffix_1: PWideChar;
suffix_2: PWideChar;
title: PWideChar;
zip_code: PWideChar;
created_at: PWideChar;
updated_at: PWideChar;
page: PWideChar;
pages: PWideChar;
limit: PWideChar;
total: PWideChar;
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 := CkHttp_Create();

queryParams := CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,'limit','<integer>');
CkJsonObject_UpdateString(queryParams,'page','<integer>');

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

resp := CkHttp_QuickRequestParams(http,'GET','https://api.easybill.de/rest/v1/customers/:customerId/contacts',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

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

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

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

// {
//   "page": "<integer>",
//   "pages": "<integer>",
//   "limit": "<integer>",
//   "total": "<integer>",
//   "items": [
//     {
//       "city": "<string>",
//       "street": "<string>",
//       "state": "<string>",
//       "company_name": "<string>",
//       "country": "<string>",
//       "department": null,
//       "fax": null,
//       "first_name": null,
//       "id": "<long>",
//       "last_name": null,
//       "login_id": "<long>",
//       "mobile": null,
//       "note": null,
//       "personal": false,
//       "phone_1": null,
//       "phone_2": null,
//       "salutation": "<integer>",
//       "suffix_1": null,
//       "suffix_2": null,
//       "title": null,
//       "zip_code": null,
//       "created_at": "<string>",
//       "updated_at": "<string>"
//     },
//     {
//       "city": "<string>",
//       "street": "<string>",
//       "state": "<string>",
//       "company_name": "<string>",
//       "country": "<string>",
//       "department": null,
//       "fax": null,
//       "first_name": null,
//       "id": "<long>",
//       "last_name": null,
//       "login_id": "<long>",
//       "mobile": null,
//       "note": null,
//       "personal": false,
//       "phone_1": null,
//       "phone_2": null,
//       "salutation": "<integer>",
//       "suffix_1": null,
//       "suffix_2": null,
//       "title": null,
//       "zip_code": null,
//       "created_at": "<string>",
//       "updated_at": "<string>"
//     }
//   ]
// }

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

page := CkJsonObject__stringOf(jResp,'page');
pages := CkJsonObject__stringOf(jResp,'pages');
limit := CkJsonObject__stringOf(jResp,'limit');
total := CkJsonObject__stringOf(jResp,'total');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'items');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    city := CkJsonObject__stringOf(jResp,'items[i].city');
    street := CkJsonObject__stringOf(jResp,'items[i].street');
    state := CkJsonObject__stringOf(jResp,'items[i].state');
    company_name := CkJsonObject__stringOf(jResp,'items[i].company_name');
    country := CkJsonObject__stringOf(jResp,'items[i].country');
    department := CkJsonObject__stringOf(jResp,'items[i].department');
    fax := CkJsonObject__stringOf(jResp,'items[i].fax');
    first_name := CkJsonObject__stringOf(jResp,'items[i].first_name');
    id := CkJsonObject__stringOf(jResp,'items[i].id');
    last_name := CkJsonObject__stringOf(jResp,'items[i].last_name');
    login_id := CkJsonObject__stringOf(jResp,'items[i].login_id');
    mobile := CkJsonObject__stringOf(jResp,'items[i].mobile');
    note := CkJsonObject__stringOf(jResp,'items[i].note');
    personal := CkJsonObject_BoolOf(jResp,'items[i].personal');
    phone_1 := CkJsonObject__stringOf(jResp,'items[i].phone_1');
    phone_2 := CkJsonObject__stringOf(jResp,'items[i].phone_2');
    salutation := CkJsonObject__stringOf(jResp,'items[i].salutation');
    suffix_1 := CkJsonObject__stringOf(jResp,'items[i].suffix_1');
    suffix_2 := CkJsonObject__stringOf(jResp,'items[i].suffix_2');
    title := CkJsonObject__stringOf(jResp,'items[i].title');
    zip_code := CkJsonObject__stringOf(jResp,'items[i].zip_code');
    created_at := CkJsonObject__stringOf(jResp,'items[i].created_at');
    updated_at := CkJsonObject__stringOf(jResp,'items[i].updated_at');
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

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/customers/:customerId/contacts

Postman Collection Item JSON

{
  "name": "Fetch customer contact list",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/customers/:customerId/contacts?limit=<integer>&page=<integer>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "customers",
        ":customerId",
        "contacts"
      ],
      "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."
        }
      ],
      "variable": [
        {
          "key": "customerId",
          "value": "<long>",
          "description": "(Required) ID of customer that needs to be fetched"
        }
      ]
    }
  },
  "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}}/customers/:customerId/contacts?limit=<integer>&page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "customers",
            ":customerId",
            "contacts"
          ],
          "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."
            }
          ],
          "variable": [
            {
              "key": "customerId"
            }
          ]
        }
      },
      "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      \"city\": \"<string>\",\n      \"street\": \"<string>\",\n      \"state\": \"<string>\",\n      \"company_name\": \"<string>\",\n      \"country\": \"<string>\",\n      \"department\": null,\n      \"fax\": null,\n      \"first_name\": null,\n      \"id\": \"<long>\",\n      \"last_name\": null,\n      \"login_id\": \"<long>\",\n      \"mobile\": null,\n      \"note\": null,\n      \"personal\": false,\n      \"phone_1\": null,\n      \"phone_2\": null,\n      \"salutation\": \"<integer>\",\n      \"suffix_1\": null,\n      \"suffix_2\": null,\n      \"title\": null,\n      \"zip_code\": null,\n      \"created_at\": \"<string>\",\n      \"updated_at\": \"<string>\"\n    },\n    {\n      \"city\": \"<string>\",\n      \"street\": \"<string>\",\n      \"state\": \"<string>\",\n      \"company_name\": \"<string>\",\n      \"country\": \"<string>\",\n      \"department\": null,\n      \"fax\": null,\n      \"first_name\": null,\n      \"id\": \"<long>\",\n      \"last_name\": null,\n      \"login_id\": \"<long>\",\n      \"mobile\": null,\n      \"note\": null,\n      \"personal\": false,\n      \"phone_1\": null,\n      \"phone_2\": null,\n      \"salutation\": \"<integer>\",\n      \"suffix_1\": null,\n      \"suffix_2\": null,\n      \"title\": null,\n      \"zip_code\": null,\n      \"created_at\": \"<string>\",\n      \"updated_at\": \"<string>\"\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}}/customers/:customerId/contacts?limit=<integer>&page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "customers",
            ":customerId",
            "contacts"
          ],
          "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."
            }
          ],
          "variable": [
            {
              "key": "customerId"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}