Chilkat Online Tools

Ruby / ShipEngine Walkthrough / Validate an address (unverified)

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

# 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"
#   }
# ]

jarr = Chilkat::CkJsonArray.new()

jarr.AddObjectAt(-1)
# jsonObj_1 is a CkJsonObject
jsonObj_1 = jarr.ObjectAt(jarr.get_Size() - 1)
jsonObj_1.UpdateString("address_line1","525 S Winchester Blvd")
jsonObj_1.UpdateString("city_locality","San Jose")
jsonObj_1.UpdateString("state_province","CA")
jsonObj_1.UpdateString("postal_code","95128")
jsonObj_1.UpdateString("country_code","USA")

http.SetRequestHeader("API-Key","{{API_KEY}}")
http.SetRequestHeader("Content-Type","application/json")

sbRequestBody = Chilkat::CkStringBuilder.new()
jarr.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("POST","https://api.shipengine.com/v1/addresses/validate",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jarrResp = Chilkat::CkJsonArray.new()
jarrResp.LoadSb(sbResponseBody)
jarrResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jarrResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# 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

i = 0
count_i = jarrResp.get_Size()
while i < count_i
    # json is a CkJsonObject
    json = jarrResp.ObjectAt(i)
    status = json.stringOf("status")
    Name = json.stringOf("original_address.name")
    Phone = json.stringOf("original_address.phone")
    Company_name = json.stringOf("original_address.company_name")
    Address_line1 = json.stringOf("original_address.address_line1")
    Address_line2 = json.stringOf("original_address.address_line2")
    Address_line3 = json.stringOf("original_address.address_line3")
    City_locality = json.stringOf("original_address.city_locality")
    State_province = json.stringOf("original_address.state_province")
    Postal_code = json.stringOf("original_address.postal_code")
    Country_code = json.stringOf("original_address.country_code")
    Address_residential_indicator = json.stringOf("original_address.address_residential_indicator")
    matched_address = json.stringOf("matched_address")
    j = 0
    count_j = json.SizeOfArray("messages")
    while j < count_j
        json.put_J(j)
        code = json.stringOf("messages[j].code")
        message = json.stringOf("messages[j].message")
        v_type = json.stringOf("messages[j].type")
        detail_code = json.stringOf("messages[j].detail_code")
        j = j + 1
    end

    i = i + 1
end

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]"
    }
  ]
}