TCL / easybill REST API / Fetch customer contact list
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "limit" "<integer>"
CkJsonObject_UpdateString $queryParams "page" "<integer>"
CkHttp_SetRequestHeader $http "Authorization" "{{apiKey}}"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://api.easybill.de/rest/v1/customers/:customerId/contacts" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $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
set page [CkJsonObject_stringOf $jResp "page"]
set pages [CkJsonObject_stringOf $jResp "pages"]
set limit [CkJsonObject_stringOf $jResp "limit"]
set total [CkJsonObject_stringOf $jResp "total"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "items"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set city [CkJsonObject_stringOf $jResp "items[i].city"]
set street [CkJsonObject_stringOf $jResp "items[i].street"]
set state [CkJsonObject_stringOf $jResp "items[i].state"]
set company_name [CkJsonObject_stringOf $jResp "items[i].company_name"]
set country [CkJsonObject_stringOf $jResp "items[i].country"]
set department [CkJsonObject_stringOf $jResp "items[i].department"]
set fax [CkJsonObject_stringOf $jResp "items[i].fax"]
set first_name [CkJsonObject_stringOf $jResp "items[i].first_name"]
set id [CkJsonObject_stringOf $jResp "items[i].id"]
set last_name [CkJsonObject_stringOf $jResp "items[i].last_name"]
set login_id [CkJsonObject_stringOf $jResp "items[i].login_id"]
set mobile [CkJsonObject_stringOf $jResp "items[i].mobile"]
set note [CkJsonObject_stringOf $jResp "items[i].note"]
set personal [CkJsonObject_BoolOf $jResp "items[i].personal"]
set phone_1 [CkJsonObject_stringOf $jResp "items[i].phone_1"]
set phone_2 [CkJsonObject_stringOf $jResp "items[i].phone_2"]
set salutation [CkJsonObject_stringOf $jResp "items[i].salutation"]
set suffix_1 [CkJsonObject_stringOf $jResp "items[i].suffix_1"]
set suffix_2 [CkJsonObject_stringOf $jResp "items[i].suffix_2"]
set title [CkJsonObject_stringOf $jResp "items[i].title"]
set zip_code [CkJsonObject_stringOf $jResp "items[i].zip_code"]
set created_at [CkJsonObject_stringOf $jResp "items[i].created_at"]
set updated_at [CkJsonObject_stringOf $jResp "items[i].updated_at"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $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": ""
}
]
}
