SQL Server / easybill REST API / Fetch customer contact list
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'limit', '<integer>'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'page', '<integer>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Authorization', '{{apiKey}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://api.easybill.de/rest/v1/customers/:customerId/contacts', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @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
DECLARE @city nvarchar(4000)
DECLARE @street nvarchar(4000)
DECLARE @state nvarchar(4000)
DECLARE @company_name nvarchar(4000)
DECLARE @country nvarchar(4000)
DECLARE @department nvarchar(4000)
DECLARE @fax nvarchar(4000)
DECLARE @first_name nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @last_name nvarchar(4000)
DECLARE @login_id nvarchar(4000)
DECLARE @mobile nvarchar(4000)
DECLARE @note nvarchar(4000)
DECLARE @personal int
DECLARE @phone_1 nvarchar(4000)
DECLARE @phone_2 nvarchar(4000)
DECLARE @salutation nvarchar(4000)
DECLARE @suffix_1 nvarchar(4000)
DECLARE @suffix_2 nvarchar(4000)
DECLARE @title nvarchar(4000)
DECLARE @zip_code nvarchar(4000)
DECLARE @created_at nvarchar(4000)
DECLARE @updated_at nvarchar(4000)
DECLARE @page nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @page OUT, 'page'
DECLARE @pages nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @pages OUT, 'pages'
DECLARE @limit nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @limit OUT, 'limit'
DECLARE @total nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @total OUT, 'total'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'items'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @city OUT, 'items[i].city'
EXEC sp_OAMethod @jResp, 'StringOf', @street OUT, 'items[i].street'
EXEC sp_OAMethod @jResp, 'StringOf', @state OUT, 'items[i].state'
EXEC sp_OAMethod @jResp, 'StringOf', @company_name OUT, 'items[i].company_name'
EXEC sp_OAMethod @jResp, 'StringOf', @country OUT, 'items[i].country'
EXEC sp_OAMethod @jResp, 'StringOf', @department OUT, 'items[i].department'
EXEC sp_OAMethod @jResp, 'StringOf', @fax OUT, 'items[i].fax'
EXEC sp_OAMethod @jResp, 'StringOf', @first_name OUT, 'items[i].first_name'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'items[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @last_name OUT, 'items[i].last_name'
EXEC sp_OAMethod @jResp, 'StringOf', @login_id OUT, 'items[i].login_id'
EXEC sp_OAMethod @jResp, 'StringOf', @mobile OUT, 'items[i].mobile'
EXEC sp_OAMethod @jResp, 'StringOf', @note OUT, 'items[i].note'
EXEC sp_OAMethod @jResp, 'BoolOf', @personal OUT, 'items[i].personal'
EXEC sp_OAMethod @jResp, 'StringOf', @phone_1 OUT, 'items[i].phone_1'
EXEC sp_OAMethod @jResp, 'StringOf', @phone_2 OUT, 'items[i].phone_2'
EXEC sp_OAMethod @jResp, 'StringOf', @salutation OUT, 'items[i].salutation'
EXEC sp_OAMethod @jResp, 'StringOf', @suffix_1 OUT, 'items[i].suffix_1'
EXEC sp_OAMethod @jResp, 'StringOf', @suffix_2 OUT, 'items[i].suffix_2'
EXEC sp_OAMethod @jResp, 'StringOf', @title OUT, 'items[i].title'
EXEC sp_OAMethod @jResp, 'StringOf', @zip_code OUT, 'items[i].zip_code'
EXEC sp_OAMethod @jResp, 'StringOf', @created_at OUT, 'items[i].created_at'
EXEC sp_OAMethod @jResp, 'StringOf', @updated_at OUT, 'items[i].updated_at'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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": ""
}
]
}
