Powershell / easybill REST API / Fetch customer contact list
Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
$queryParams = New-Object Chilkat.JsonObject
$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/customers/:customerId/contacts",$queryParams)
if ($http.LastMethodSuccess -eq $false) {
$($http.LastErrorText)
exit
}
$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($resp.Header)
$("Failed.")
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 -lt $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": ""
}
]
}
