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, 'UpdateInt', @success OUT, 'location-code', 1234568
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'fields', '["id","name","active","street1","street2","city","state","postal_code","location_code",{"country":{}},{"tax_registrations":{}},{"custom_fields":{}}]'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://domain.com/addresses', @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
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
PRINT @iTmp0
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
END
GO
Curl Command
curl -G -d "location-code=1234568"
-d "fields=%5B%22id%22,%22name%22,%22active%22,%22street1%22,%22street2%22,%22city%22,%22state%22,%22postal_code%22,%22location_code%22,%7B%22country%22%3A%7B%7D%7D,%7B%22tax_registrations%22%3A%7B%7D%7D,%7B%22custom_fields%22%3A%7B%7D%7D%5D"
-H "Authorization: Bearer <access_token>"
https://domain.com/addresses
Postman Collection Item JSON
{
"name": "Get Address by Location Code",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{URL}}/addresses?location-code=1234568&fields=[\"id\",\"name\",\"active\",\"street1\",\"street2\",\"city\",\"state\",\"postal_code\",\"location_code\",{\"country\":{}},{\"tax_registrations\":{}},{\"custom_fields\":{}}]",
"host": [
"{{URL}}"
],
"path": [
"addresses"
],
"query": [
{
"key": "location-code",
"value": "1234568"
},
{
"key": "fields",
"value": "[\"id\",\"name\",\"active\",\"street1\",\"street2\",\"city\",\"state\",\"postal_code\",\"location_code\",{\"country\":{}},{\"tax_registrations\":{}},{\"custom_fields\":{}}]"
}
]
}
},
"response": [
]
}