autoit / 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.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("limit","<integer>")
$oQueryParams.UpdateString("page","<integer>")
$oHttp.SetRequestHeader "Authorization","{{apiKey}}"
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.QuickRequestParams("GET","https://api.easybill.de/rest/v1/customers/:customerId/contacts",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sCity
Local $street
Local $state
Local $sCompany_name
Local $sCountry
Local $sDepartment
Local $sFax
Local $sFirst_name
Local $sId
Local $sLast_name
Local $sLogin_id
Local $sMobile
Local $sNote
Local $bPersonal
Local $sPhone_1
Local $sPhone_2
Local $salutation
Local $suffix_1
Local $suffix_2
Local $sTitle
Local $sZip_code
Local $sCreated_at
Local $sUpdated_at
Local $sPage = $oJResp.StringOf("page")
Local $sPages = $oJResp.StringOf("pages")
Local $sLimit = $oJResp.StringOf("limit")
Local $sTotal = $oJResp.StringOf("total")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("items")
While $i < $iCount_i
$oJResp.I = $i
$sCity = $oJResp.StringOf("items[i].city")
$street = $oJResp.StringOf("items[i].street")
$state = $oJResp.StringOf("items[i].state")
$sCompany_name = $oJResp.StringOf("items[i].company_name")
$sCountry = $oJResp.StringOf("items[i].country")
$sDepartment = $oJResp.StringOf("items[i].department")
$sFax = $oJResp.StringOf("items[i].fax")
$sFirst_name = $oJResp.StringOf("items[i].first_name")
$sId = $oJResp.StringOf("items[i].id")
$sLast_name = $oJResp.StringOf("items[i].last_name")
$sLogin_id = $oJResp.StringOf("items[i].login_id")
$sMobile = $oJResp.StringOf("items[i].mobile")
$sNote = $oJResp.StringOf("items[i].note")
$bPersonal = $oJResp.BoolOf("items[i].personal")
$sPhone_1 = $oJResp.StringOf("items[i].phone_1")
$sPhone_2 = $oJResp.StringOf("items[i].phone_2")
$salutation = $oJResp.StringOf("items[i].salutation")
$suffix_1 = $oJResp.StringOf("items[i].suffix_1")
$suffix_2 = $oJResp.StringOf("items[i].suffix_2")
$sTitle = $oJResp.StringOf("items[i].title")
$sZip_code = $oJResp.StringOf("items[i].zip_code")
$sCreated_at = $oJResp.StringOf("items[i].created_at")
$sUpdated_at = $oJResp.StringOf("items[i].updated_at")
$i = $i + 1
Wend
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": ""
}
]
}
