(JavaScript) Shippo Validate Global Address

Demonstrates how to validate a global address.

For more information, see https://goshippo.com/docs/address-validation/

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

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

var http = new CkHttp();

// Implements the following CURL command:

// curl https://api.goshippo.com/addresses/ \
//     -H "Authorization: ShippoToken <API_TOKEN>" \
//     -d name="Shawn Ippotle" \
//     -d company="Shippo" \
//     -d street1="Kortrijksesteenweg 1005" \
//     -d city="Gent" \
//     -d zip=9000 \
//     -d country="BE" \
//     -d email="shippotle@goshippo.com"\
//     -d validate=true

var req = new CkHttpRequest();
req.HttpVerb = "POST";
req.Path = "/addresses/";
req.ContentType = "application/x-www-form-urlencoded";
req.AddParam("name","Shawn Ippotle");
req.AddParam("company","Shippo");
req.AddParam("street1","Kortrijksesteenweg 1005");
req.AddParam("city","Gent");
req.AddParam("zip","9000");
req.AddParam("country","BE");
req.AddParam("email","shippotle@goshippo.com");
req.AddParam("validate","true");

req.AddHeader("Authorization","ShippoToken <API_TOKEN>");

var resp = new CkHttpResponse();
success = http.HttpReq("https://api.goshippo.com/addresses/",req,resp);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

var sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

console.log("Response Body:");
console.log(jResp.Emit());

var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
    console.log("Response Header:");
    console.log(resp.Header);
    console.log("Failed.");
    return;
}

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

// {
//   "object_created": "2017-07-26T17:52:37.305Z",
//   "object_updated": "2017-07-26T17:52:37.351Z",
//   "object_id": "b7f9709df3914d1ca6efe4c30e7b0572",
//   "is_complete": true,
//   "validation_results": {
//     "is_valid": true,
//     "messages": [
//       {
//         "source": "Shippo Address Validator",
//         "type": "address_correction",
//         "code": "administrative_area_change",
//         "text": "The administrative area (state or province) was added or changed."
//       },
//       {
//         "source": "Shippo Address Validator",
//         "code": "geocoded_rooftop",
//         "text": "The record was geocoded down to rooftop level, meaning the point is within the property boundaries (most often the center)."
//       },
//       {
//         "source": "Shippo Address Validator",
//         "code": "premises_full",
//         "text": "The address has been verified to the Premise (House or Building) Level, which is the highest level possible with the reference data."
//       }
//     ]
//   },
//   "object_owner": "hippo@goshippo.com",
//   "name": "Hippo Shippo",
//   "company": "Shippo",
//   "street_no": "2",
//   "street1": "Unter den Linden",
//   "street2": "",
//   "street3": "",
//   "city": "Berlin",
//   "state": "",
//   "zip": "10117",
//   "country": "DE",
//   "longitude": "13.39751",
//   "latitude": "52.51785",
//   "phone": "14151234567",
//   "email": "hippo@goshippo.com",
//   "is_residential": null,
//   "metadata": "",
//   "test": false
// }

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

var source;
var v_type;
var code;
var text;

var object_created = jResp.StringOf("object_created");
var object_updated = jResp.StringOf("object_updated");
var object_id = jResp.StringOf("object_id");
var is_complete = jResp.BoolOf("is_complete");
var validation_resultsIs_valid = jResp.BoolOf("validation_results.is_valid");
var object_owner = jResp.StringOf("object_owner");
var name = jResp.StringOf("name");
var company = jResp.StringOf("company");
var street_no = jResp.StringOf("street_no");
var street1 = jResp.StringOf("street1");
var street2 = jResp.StringOf("street2");
var street3 = jResp.StringOf("street3");
var city = jResp.StringOf("city");
var state = jResp.StringOf("state");
var zip = jResp.StringOf("zip");
var country = jResp.StringOf("country");
var longitude = jResp.StringOf("longitude");
var latitude = jResp.StringOf("latitude");
var phone = jResp.StringOf("phone");
var email = jResp.StringOf("email");
var is_residential = jResp.StringOf("is_residential");
var metadata = jResp.StringOf("metadata");
var test = jResp.BoolOf("test");
var i = 0;
var count_i = jResp.SizeOfArray("validation_results.messages");
while (i < count_i) {
    jResp.I = i;
    source = jResp.StringOf("validation_results.messages[i].source");
    v_type = jResp.StringOf("validation_results.messages[i].type");
    code = jResp.StringOf("validation_results.messages[i].code");
    text = jResp.StringOf("validation_results.messages[i].text");
    i = i+1;
}