Chilkat Online Tools

Swift3 / ShipEngine Walkthrough / Validate an address (invalid)

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    // 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": "Winchester Blvd",
    //     "city_locality": "San Jose",
    //     "state_province": "CA",
    //     "postal_code": "78756",
    //     "country_code": "US"
    //   }
    // ]

    let jarr = CkoJsonArray()!

    jarr.addObject(at: -1)
    var jsonObj_1: CkoJsonObject? = jarr.object(at: jarr.size.intValue - 1)
    jsonObj_1!.update("address_line1", value: "Winchester Blvd")
    jsonObj_1!.update("city_locality", value: "San Jose")
    jsonObj_1!.update("state_province", value: "CA")
    jsonObj_1!.update("postal_code", value: "78756")
    jsonObj_1!.update("country_code", value: "US")
    jsonObj_1 = nil

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

    let sbRequestBody = CkoStringBuilder()!
    jarr.emitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.pTextSb("POST", url: "https://api.shipengine.com/v1/addresses/validate", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jarrResp = CkoJsonArray()!
    jarrResp.loadSb(sbResponseBody)
    jarrResp.emitCompact = false

    print("Response Body:")
    print("\(jarrResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // [
    //   {
    //     "status": "error",
    //     "original_address": {
    //       "name": null,
    //       "phone": null,
    //       "company_name": null,
    //       "address_line1": "Winchester Blvd",
    //       "address_line2": null,
    //       "address_line3": null,
    //       "city_locality": "San Jose",
    //       "state_province": "CA",
    //       "postal_code": "78756",
    //       "country_code": "US",
    //       "address_residential_indicator": "unknown"
    //     },
    //     "matched_address": null,
    //     "messages": [
    //       {
    //         "code": "a1004",
    //         "message": "Address not found",
    //         "type": "warning",
    //         "detail_code": null
    //       },
    //       {
    //         "code": "a1002",
    //         "message": "Invalid City, State, or Zip",
    //         "type": "error",
    //         "detail_code": null
    //       },
    //       {
    //         "code": "a1004",
    //         "message": "Insufficient or Incorrect Address Data",
    //         "type": "warning",
    //         "detail_code": null
    //       }
    //     ]
    //   }
    // ]

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var json: CkoJsonObject?
    var status: String?
    var Name: String?
    var Phone: String?
    var Company_name: String?
    var Address_line1: String?
    var Address_line2: String?
    var Address_line3: String?
    var City_locality: String?
    var State_province: String?
    var Postal_code: String?
    var Country_code: String?
    var Address_residential_indicator: String?
    var matched_address: String?
    var j: Int
    var count_j: Int
    var code: String?
    var message: String?
    var v_type: String?
    var detail_code: String?

    var i: Int = 0
    var count_i: Int = jarrResp.size.intValue
    while i < count_i {
        json = jarrResp.object(at: i)
        status = json!.string(of: "status")
        Name = json!.string(of: "original_address.name")
        Phone = json!.string(of: "original_address.phone")
        Company_name = json!.string(of: "original_address.company_name")
        Address_line1 = json!.string(of: "original_address.address_line1")
        Address_line2 = json!.string(of: "original_address.address_line2")
        Address_line3 = json!.string(of: "original_address.address_line3")
        City_locality = json!.string(of: "original_address.city_locality")
        State_province = json!.string(of: "original_address.state_province")
        Postal_code = json!.string(of: "original_address.postal_code")
        Country_code = json!.string(of: "original_address.country_code")
        Address_residential_indicator = json!.string(of: "original_address.address_residential_indicator")
        matched_address = json!.string(of: "matched_address")
        j = 0
        count_j = json!.size(ofArray: "messages").intValue
        while j < count_j {
            json.j = j
            code = json!.string(of: "messages[j].code")
            message = json!.string(of: "messages[j].message")
            v_type = json!.string(of: "messages[j].type")
            detail_code = json!.string(of: "messages[j].detail_code")
            j = j + 1
        }

        json = nil
        i = i + 1
    }


}

Curl Command

curl -X POST
	-H "API-Key: {{API_KEY}}"
	-H "Content-Type: application/json"
	-d '[
	{
		"address_line1": "Winchester Blvd",
		"city_locality": "San Jose",
		"state_province": "CA",
		"postal_code": "78756",
		"country_code": "US"
	}
]'
https://api.shipengine.com/v1/addresses/validate

Postman Collection Item JSON

{
  "name": "Validate an address (invalid)",
  "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\": \"Winchester Blvd\",\n\t\t\"city_locality\": \"San Jose\",\n\t\t\"state_province\": \"CA\",\n\t\t\"postal_code\": \"78756\",\n\t\t\"country_code\": \"US\"\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 is invalid. The `status` field is `error`, and the `messages` array lists the problems with the address."
  },
  "response": [
    {
      "name": "Validate an address (corrected) Copy",
      "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\": \"Winchester Blvd\",\n\t\t\"city_locality\": \"San Jose\",\n\t\t\"state_province\": \"CA\",\n\t\t\"postal_code\": \"78756\",\n\t\t\"country_code\": \"US\"\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": "Wed, 18 Sep 2019 14:26:11 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "938"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "https://www.shipengine.com"
        },
        {
          "key": "Vary",
          "value": "Origin"
        },
        {
          "key": "x-shipengine-requestid",
          "value": "d582f7b7-7c4d-4f5a-aace-003457e14992"
        }
      ],
      "cookie": [
      ],
      "body": "[\n    {\n        \"status\": \"error\",\n        \"original_address\": {\n            \"name\": null,\n            \"phone\": null,\n            \"company_name\": null,\n            \"address_line1\": \"Winchester Blvd\",\n            \"address_line2\": null,\n            \"address_line3\": null,\n            \"city_locality\": \"San Jose\",\n            \"state_province\": \"CA\",\n            \"postal_code\": \"78756\",\n            \"country_code\": \"US\",\n            \"address_residential_indicator\": \"unknown\"\n        },\n        \"matched_address\": null,\n        \"messages\": [\n            {\n                \"code\": \"a1004\",\n                \"message\": \"Address not found\",\n                \"type\": \"warning\",\n                \"detail_code\": null\n            },\n            {\n                \"code\": \"a1002\",\n                \"message\": \"Invalid City, State, or Zip\",\n                \"type\": \"error\",\n                \"detail_code\": null\n            },\n            {\n                \"code\": \"a1004\",\n                \"message\": \"Insufficient or Incorrect Address Data\",\n                \"type\": \"warning\",\n                \"detail_code\": null\n            }\n        ]\n    }\n]"
    }
  ]
}