Chilkat Online Tools

Objective-C / ShipEngine Walkthrough / Validate an address (invalid)

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonArray.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoHttpResponse.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

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

CkoJsonArray *jarr = [[CkoJsonArray alloc] init];

[jarr AddObjectAt: [NSNumber numberWithInt: -1]];
CkoJsonObject *jsonObj_1 = [jarr ObjectAt: [NSNumber numberWithInt: ([jarr.Size intValue] - 1)]];
[jsonObj_1 UpdateString: @"address_line1" value: @"Winchester Blvd"];
[jsonObj_1 UpdateString: @"city_locality" value: @"San Jose"];
[jsonObj_1 UpdateString: @"state_province" value: @"CA"];
[jsonObj_1 UpdateString: @"postal_code" value: @"78756"];
[jsonObj_1 UpdateString: @"country_code" value: @"US"];

[http SetRequestHeader: @"API-Key" value: @"{{API_KEY}}"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];

CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[jarr EmitSb: sbRequestBody];

CkoHttpResponse *resp = [http PTextSb: @"POST" url: @"https://api.shipengine.com/v1/addresses/validate" textData: sbRequestBody charset: @"utf-8" contentType: @"application/json" md5: NO gzip: NO];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonArray *jarrResp = [[CkoJsonArray alloc] init];
[jarrResp LoadSb: sbResponseBody];
jarrResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jarrResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

// 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

CkoJsonObject *json = 0;
NSString *status = 0;
NSString *Name = 0;
NSString *Phone = 0;
NSString *Company_name = 0;
NSString *Address_line1 = 0;
NSString *Address_line2 = 0;
NSString *Address_line3 = 0;
NSString *City_locality = 0;
NSString *State_province = 0;
NSString *Postal_code = 0;
NSString *Country_code = 0;
NSString *Address_residential_indicator = 0;
NSString *matched_address = 0;
int j;
int count_j;
NSString *code = 0;
NSString *message = 0;
NSString *v_type = 0;
NSString *detail_code = 0;

int i = 0;
int count_i = [jarrResp.Size intValue];
while (i < count_i) {
    json = [jarrResp ObjectAt: [NSNumber numberWithInt: 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"] intValue];
    while (j < count_j) {
        json.J = [NSNumber numberWithInt: 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;
    }

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