Chilkat Online Tools

.NET Core C# / easybill REST API / Fetch customer contact list

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;

Chilkat.JsonObject queryParams = new Chilkat.JsonObject();
queryParams.UpdateString("limit","<integer>");
queryParams.UpdateString("page","<integer>");

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

Chilkat.HttpResponse resp = http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/customers/:customerId/contacts",queryParams);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);

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

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

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("Failed.");

    return;
}

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

string city;
string street;
string state;
string company_name;
string country;
string department;
string fax;
string first_name;
string id;
string last_name;
string login_id;
string mobile;
string note;
bool personal;
string phone_1;
string phone_2;
string salutation;
string suffix_1;
string suffix_2;
string title;
string zip_code;
string created_at;
string updated_at;

string page = jResp.StringOf("page");
string pages = jResp.StringOf("pages");
string limit = jResp.StringOf("limit");
string total = jResp.StringOf("total");
int i = 0;
int count_i = jResp.SizeOfArray("items");
while (i < count_i) {
    jResp.I = i;
    city = jResp.StringOf("items[i].city");
    street = jResp.StringOf("items[i].street");
    state = jResp.StringOf("items[i].state");
    company_name = jResp.StringOf("items[i].company_name");
    country = jResp.StringOf("items[i].country");
    department = jResp.StringOf("items[i].department");
    fax = jResp.StringOf("items[i].fax");
    first_name = jResp.StringOf("items[i].first_name");
    id = jResp.StringOf("items[i].id");
    last_name = jResp.StringOf("items[i].last_name");
    login_id = jResp.StringOf("items[i].login_id");
    mobile = jResp.StringOf("items[i].mobile");
    note = jResp.StringOf("items[i].note");
    personal = jResp.BoolOf("items[i].personal");
    phone_1 = jResp.StringOf("items[i].phone_1");
    phone_2 = jResp.StringOf("items[i].phone_2");
    salutation = jResp.StringOf("items[i].salutation");
    suffix_1 = jResp.StringOf("items[i].suffix_1");
    suffix_2 = jResp.StringOf("items[i].suffix_2");
    title = jResp.StringOf("items[i].title");
    zip_code = jResp.StringOf("items[i].zip_code");
    created_at = jResp.StringOf("items[i].created_at");
    updated_at = jResp.StringOf("items[i].updated_at");
    i = i + 1;
}

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