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
-- Use this online tool to generate code from sample XML: Generate Code to Create XML
-- The following XML is sent in the request body.
-- <?xml version="1.0" encoding="utf-8"?>
-- <address>
-- <name>address name is ok</name>
-- <location-code>CODEUPDATE1</location-code>
-- <street1>lineaddress1</street1>
-- <street2>lineaddress2</street2>
-- <city>Elko</city>
-- <state>NV</state>
-- <postal-code>08551-3423</postal-code>
-- <active>true</active>
-- <country>
-- <code>US</code>
-- </country>
-- <custom-fields>
-- <date type="dateTime">2021-11-12</date>
-- </custom-fields>
-- </address>
--
DECLARE @xml int
-- Use "Chilkat_9_5_0.Xml" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Xml', @xml OUT
EXEC sp_OASetProperty @xml, 'Tag', 'address'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'name', 'address name is ok'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'location-code', 'CODEUPDATE1'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'street1', 'lineaddress1'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'street2', 'lineaddress2'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'city', 'Elko'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'state', 'NV'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'postal-code', '08551-3423'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'active', 'true'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'country|code', 'US'
EXEC sp_OAMethod @xml, 'UpdateAttrAt', @success OUT, 'custom-fields|date', 1, 'type', 'dateTime'
EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'custom-fields|date', '2021-11-12'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @sbRequestBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @xml, 'GetXmlSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://domain.com/addresses/:id?fields=["id","name","active","street1","street2","city","state","postal_code","location_code",{"country":{}},{"tax_registrations":{}},{"custom_fields":{}}]', @sbRequestBody, 'utf-8', 'application/xml', 0, 0
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 @xml
EXEC @hr = sp_OADestroy @sbRequestBody
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 @xml
EXEC @hr = sp_OADestroy @sbRequestBody
END
GO
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-d '<address>
<name>address name is ok</name>
<location-code>CODEUPDATE1</location-code>
<street1>lineaddress1</street1>
<street2>lineaddress2</street2>
<city>Elko</city>
<state>NV</state>
<postal-code>08551-3423</postal-code>
<active>true</active>
<country>
<code>US</code>
</country>
<custom-fields>
<date type="dateTime">2021-11-12</date>
</custom-fields>
</address>'
https://domain.com/addresses/:id?fields=["id","name","active","street1","street2","city","state","postal_code","location_code",{"country":{}},{"tax_registrations":{}},{"custom_fields":{}}]
Postman Collection Item JSON
{
"name": "Update Existing Address",
"request": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "<address>\n <name>address name is ok</name>\n <location-code>CODEUPDATE1</location-code>\n <street1>lineaddress1</street1>\n <street2>lineaddress2</street2>\n <city>Elko</city>\n <state>NV</state>\n <postal-code>08551-3423</postal-code>\n <active>true</active>\n <country>\n <code>US</code>\n </country>\n <custom-fields>\n <date type=\"dateTime\">2021-11-12</date>\n </custom-fields>\n</address>",
"options": {
"raw": {
"language": "xml"
}
}
},
"url": {
"raw": "{{URL}}/addresses/:id?fields=[\"id\",\"name\",\"active\",\"street1\",\"street2\",\"city\",\"state\",\"postal_code\",\"location_code\",{\"country\":{}},{\"tax_registrations\":{}},{\"custom_fields\":{}}]",
"host": [
"{{URL}}"
],
"path": [
"addresses",
":id"
],
"query": [
{
"key": "fields",
"value": "[\"id\",\"name\",\"active\",\"street1\",\"street2\",\"city\",\"state\",\"postal_code\",\"location_code\",{\"country\":{}},{\"tax_registrations\":{}},{\"custom_fields\":{}}]"
}
],
"variable": [
{
"key": "id",
"value": "4882"
}
]
}
},
"response": [
]
}