SQL Server / ShipEngine Walkthrough / Validate an address (unverified)
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 JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- [
-- {
-- "address_line1": "525 S Winchester Blvd",
-- "city_locality": "San Jose",
-- "state_province": "CA",
-- "postal_code": "95128",
-- "country_code": "USA"
-- }
-- ]
DECLARE @jarr int
-- Use "Chilkat_9_5_0.JsonArray" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonArray', @jarr OUT
EXEC sp_OAMethod @jarr, 'AddObjectAt', @success OUT, -1
DECLARE @jsonObj_1 int
EXEC sp_OAGetProperty @jarr, 'Size', @iTmp0 OUT
EXEC sp_OAMethod @jarr, 'ObjectAt', @jsonObj_1 OUT, @iTmp0 - 1
EXEC sp_OAMethod @jsonObj_1, 'UpdateString', @success OUT, 'address_line1', '525 S Winchester Blvd'
EXEC sp_OAMethod @jsonObj_1, 'UpdateString', @success OUT, 'city_locality', 'San Jose'
EXEC sp_OAMethod @jsonObj_1, 'UpdateString', @success OUT, 'state_province', 'CA'
EXEC sp_OAMethod @jsonObj_1, 'UpdateString', @success OUT, 'postal_code', '95128'
EXEC sp_OAMethod @jsonObj_1, 'UpdateString', @success OUT, 'country_code', 'USA'
EXEC @hr = sp_OADestroy @jsonObj_1
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'API-Key', '{{API_KEY}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
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 @jarr, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'POST', 'https://api.shipengine.com/v1/addresses/validate', @sbRequestBody, 'utf-8', 'application/json', 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 @jarr
EXEC @hr = sp_OADestroy @sbRequestBody
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 @jarrResp int
-- Use "Chilkat_9_5_0.JsonArray" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonArray', @jarrResp OUT
EXEC sp_OAMethod @jarrResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jarrResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jarrResp, '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 @jarr
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jarrResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- [
-- {
-- "status": "unverified",
-- "original_address": {
-- "name": null,
-- "phone": null,
-- "company_name": null,
-- "address_line1": "525 S Winchester Blvd",
-- "address_line2": null,
-- "address_line3": null,
-- "city_locality": "San Jose",
-- "state_province": "CA",
-- "postal_code": "95128",
-- "country_code": "USA",
-- "address_residential_indicator": "unknown"
-- },
-- "matched_address": null,
-- "messages": [
-- {
-- "code": "a1005",
-- "message": "Length of property 'country_code' must equal exactly 2",
-- "type": "error",
-- "detail_code": "country_invalid_length"
-- },
-- {
-- "code": "a1001",
-- "message": "country_code is not currently a supported country, please check the documentation for acceptable 2-letter country codes.",
-- "type": "error",
-- "detail_code": "unsupported_country"
-- }
-- ]
-- }
-- ]
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @json int
DECLARE @status nvarchar(4000)
DECLARE @Name nvarchar(4000)
DECLARE @Phone nvarchar(4000)
DECLARE @Company_name nvarchar(4000)
DECLARE @Address_line1 nvarchar(4000)
DECLARE @Address_line2 nvarchar(4000)
DECLARE @Address_line3 nvarchar(4000)
DECLARE @City_locality nvarchar(4000)
DECLARE @State_province nvarchar(4000)
DECLARE @Postal_code nvarchar(4000)
DECLARE @Country_code nvarchar(4000)
DECLARE @Address_residential_indicator nvarchar(4000)
DECLARE @matched_address nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @code nvarchar(4000)
DECLARE @message nvarchar(4000)
DECLARE @v_type nvarchar(4000)
DECLARE @detail_code nvarchar(4000)
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAGetProperty @jarrResp, 'Size', @count_i OUT
WHILE @i < @count_i
BEGIN
EXEC sp_OAMethod @jarrResp, 'ObjectAt', @json OUT, @i
EXEC sp_OAMethod @json, 'StringOf', @status OUT, 'status'
EXEC sp_OAMethod @json, 'StringOf', @Name OUT, 'original_address.name'
EXEC sp_OAMethod @json, 'StringOf', @Phone OUT, 'original_address.phone'
EXEC sp_OAMethod @json, 'StringOf', @Company_name OUT, 'original_address.company_name'
EXEC sp_OAMethod @json, 'StringOf', @Address_line1 OUT, 'original_address.address_line1'
EXEC sp_OAMethod @json, 'StringOf', @Address_line2 OUT, 'original_address.address_line2'
EXEC sp_OAMethod @json, 'StringOf', @Address_line3 OUT, 'original_address.address_line3'
EXEC sp_OAMethod @json, 'StringOf', @City_locality OUT, 'original_address.city_locality'
EXEC sp_OAMethod @json, 'StringOf', @State_province OUT, 'original_address.state_province'
EXEC sp_OAMethod @json, 'StringOf', @Postal_code OUT, 'original_address.postal_code'
EXEC sp_OAMethod @json, 'StringOf', @Country_code OUT, 'original_address.country_code'
EXEC sp_OAMethod @json, 'StringOf', @Address_residential_indicator OUT, 'original_address.address_residential_indicator'
EXEC sp_OAMethod @json, 'StringOf', @matched_address OUT, 'matched_address'
SELECT @j = 0
EXEC sp_OAMethod @json, 'SizeOfArray', @count_j OUT, 'messages'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @json, 'J', @j
EXEC sp_OAMethod @json, 'StringOf', @code OUT, 'messages[j].code'
EXEC sp_OAMethod @json, 'StringOf', @message OUT, 'messages[j].message'
EXEC sp_OAMethod @json, 'StringOf', @v_type OUT, 'messages[j].type'
EXEC sp_OAMethod @json, 'StringOf', @detail_code OUT, 'messages[j].detail_code'
SELECT @j = @j + 1
END
EXEC @hr = sp_OADestroy @json
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @jarr
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jarrResp
END
GO
Curl Command
curl -X POST
-H "API-Key: {{API_KEY}}"
-H "Content-Type: application/json"
-d '[
{
"address_line1": "525 S Winchester Blvd",
"city_locality": "San Jose",
"state_province": "CA",
"postal_code": "95128",
"country_code": "USA"
}
]'
https://api.shipengine.com/v1/addresses/validate
Postman Collection Item JSON
{
"name": "Validate an address (unverified)",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "[\n\t{\n\t\t\"address_line1\": \"525 S Winchester Blvd\",\n\t\t\"city_locality\": \"San Jose\",\n\t\t\"state_province\": \"CA\",\n\t\t\"postal_code\": \"95128\",\n\t\t\"country_code\": \"USA\"\n\t}\n]"
},
"url": {
"raw": "https://api.shipengine.com/v1/addresses/validate",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"addresses",
"validate"
]
},
"description": "This request shows how ShipEngine responds when an address cannot be verified. The `status` field is `unverified`, and the `messages` array lists the problems with the address."
},
"response": [
{
"name": "Validate an address (unverified)",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "[\n\t{\n\t\t\"address_line1\": \"525 S Winchester Blvd\",\n\t\t\"city_locality\": \"San Jose\",\n\t\t\"state_province\": \"CA\",\n\t\t\"postal_code\": \"95128\",\n\t\t\"country_code\": \"USA\"\n\t}\n]",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.shipengine.com/v1/addresses/validate",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"addresses",
"validate"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Tue, 22 Oct 2019 20:28:48 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "951"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "118b96e8-1e29-4ded-ba33-62a661e55038"
}
],
"cookie": [
],
"body": "[\n {\n \"status\": \"unverified\",\n \"original_address\": {\n \"name\": null,\n \"phone\": null,\n \"company_name\": null,\n \"address_line1\": \"525 S Winchester Blvd\",\n \"address_line2\": null,\n \"address_line3\": null,\n \"city_locality\": \"San Jose\",\n \"state_province\": \"CA\",\n \"postal_code\": \"95128\",\n \"country_code\": \"USA\",\n \"address_residential_indicator\": \"unknown\"\n },\n \"matched_address\": null,\n \"messages\": [\n {\n \"code\": \"a1005\",\n \"message\": \"Length of property 'country_code' must equal exactly 2\",\n \"type\": \"error\",\n \"detail_code\": \"country_invalid_length\"\n },\n {\n \"code\": \"a1001\",\n \"message\": \"country_code is not currently a supported country, please check the documentation for acceptable 2-letter country codes.\",\n \"type\": \"error\",\n \"detail_code\": \"unsupported_country\"\n }\n ]\n }\n]"
}
]
}
