phpAx / easybill REST API / Fetch customer contact list
Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$queryParams = new COM("Chilkat.JsonObject");
$queryParams->UpdateString('limit','<integer>');
$queryParams->UpdateString('page','<integer>');
$http->SetRequestHeader('Authorization','{{apiKey}}');
$http->SetRequestHeader('Accept','application/json');
// resp is a Chilkat.HttpResponse
$resp = $http->QuickRequestParams('GET','https://api.easybill.de/rest/v1/customers/:customerId/contacts',$queryParams);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->Header . "\n";
print 'Failed.' . "\n";
exit;
}
// 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 = $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) {
$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": ""
}
]
}
