delphiAx / ShipEngine Walkthrough / Validate an address (incomplete)
Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
jarr: TChilkatJsonArray;
jsonObj_1: IChilkatJsonObject;
sbRequestBody: TChilkatStringBuilder;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jarrResp: TChilkatJsonArray;
respStatusCode: Integer;
json: IChilkatJsonObject;
status: WideString;
Name: WideString;
Phone: WideString;
Company_name: WideString;
Address_line1: WideString;
Address_line2: WideString;
Address_line3: WideString;
City_locality: WideString;
State_province: WideString;
Postal_code: WideString;
Country_code: WideString;
Address_residential_indicator: WideString;
matched_addressName: WideString;
matched_addressPhone: WideString;
matched_addressCompany_name: WideString;
matched_addressAddress_line1: WideString;
matched_addressAddress_line2: WideString;
matched_addressAddress_line3: WideString;
matched_addressCity_locality: WideString;
matched_addressState_province: WideString;
matched_addressPostal_code: WideString;
matched_addressCountry_code: WideString;
matched_addressAddress_residential_indicator: WideString;
j: Integer;
count_j: Integer;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := TChilkatHttp.Create(Self);
// 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 Winchester",
// "postal_code": "95128",
// "country_code": "US"
// }
// ]
jarr := TChilkatJsonArray.Create(Self);
jarr.AddObjectAt(-1);
jsonObj_1 := jarr.ObjectAt(jarr.Size - 1);
jsonObj_1.UpdateString('address_line1','525 Winchester');
jsonObj_1.UpdateString('postal_code','95128');
jsonObj_1.UpdateString('country_code','US');
http.SetRequestHeader('API-Key','{{API_KEY}}');
http.SetRequestHeader('Content-Type','application/json');
sbRequestBody := TChilkatStringBuilder.Create(Self);
jarr.EmitSb(sbRequestBody.ControlInterface);
resp := http.PTextSb('POST','https://api.shipengine.com/v1/addresses/validate',sbRequestBody.ControlInterface,'utf-8','application/json',0,0);
if (http.LastMethodSuccess = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);
jarrResp := TChilkatJsonArray.Create(Self);
jarrResp.LoadSb(sbResponseBody.ControlInterface);
jarrResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jarrResp.Emit());
respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(resp.Header);
Memo1.Lines.Add('Failed.');
Exit;
end;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// [
// {
// "status": "verified",
// "original_address": {
// "name": null,
// "phone": null,
// "company_name": null,
// "address_line1": "525 Winchester",
// "address_line2": null,
// "address_line3": null,
// "city_locality": null,
// "state_province": null,
// "postal_code": "95128",
// "country_code": "US",
// "address_residential_indicator": "unknown"
// },
// "matched_address": {
// "name": null,
// "phone": null,
// "company_name": null,
// "address_line1": "525 S WINCHESTER BLVD",
// "address_line2": "",
// "address_line3": null,
// "city_locality": "SAN JOSE",
// "state_province": "CA",
// "postal_code": "95128-2537",
// "country_code": "US",
// "address_residential_indicator": "no"
// },
// "messages": [
// ]
// }
// ]
// 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.Size;
while i < count_i do
begin
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_addressName := json.StringOf('matched_address.name');
matched_addressPhone := json.StringOf('matched_address.phone');
matched_addressCompany_name := json.StringOf('matched_address.company_name');
matched_addressAddress_line1 := json.StringOf('matched_address.address_line1');
matched_addressAddress_line2 := json.StringOf('matched_address.address_line2');
matched_addressAddress_line3 := json.StringOf('matched_address.address_line3');
matched_addressCity_locality := json.StringOf('matched_address.city_locality');
matched_addressState_province := json.StringOf('matched_address.state_province');
matched_addressPostal_code := json.StringOf('matched_address.postal_code');
matched_addressCountry_code := json.StringOf('matched_address.country_code');
matched_addressAddress_residential_indicator := json.StringOf('matched_address.address_residential_indicator');
j := 0;
count_j := json.SizeOfArray('messages');
while j < count_j do
begin
json.J := j;
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 Winchester",
"postal_code": "95128",
"country_code": "US"
}
]'
https://api.shipengine.com/v1/addresses/validate
Postman Collection Item JSON
{
"name": "Validate an address (incomplete)",
"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 Winchester\",\n\t\t\"postal_code\": \"95128\",\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 demonstrates ShipEngine's ability to validate and fill-in an incomplete address. For most addresses, a `postal_code` is sufficient to fill-in the `city_locality` and `state_province`, or vice-versa. Also notice that the incomplete stree address (525 Winchester) is filled-in as well (525 S Winchester Blvd)."
},
"response": [
{
"name": "Validate an address (incomplete)",
"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 Winchester\",\n\t\t\"postal_code\": \"95128\",\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:10:26 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "831"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "9bf1b583-40ed-4715-92b7-0e6bd6cd374c"
}
],
"cookie": [
],
"body": "[\n {\n \"status\": \"verified\",\n \"original_address\": {\n \"name\": null,\n \"phone\": null,\n \"company_name\": null,\n \"address_line1\": \"525 Winchester\",\n \"address_line2\": null,\n \"address_line3\": null,\n \"city_locality\": null,\n \"state_province\": null,\n \"postal_code\": \"95128\",\n \"country_code\": \"US\",\n \"address_residential_indicator\": \"unknown\"\n },\n \"matched_address\": {\n \"name\": null,\n \"phone\": null,\n \"company_name\": null,\n \"address_line1\": \"525 S WINCHESTER BLVD\",\n \"address_line2\": \"\",\n \"address_line3\": null,\n \"city_locality\": \"SAN JOSE\",\n \"state_province\": \"CA\",\n \"postal_code\": \"95128-2537\",\n \"country_code\": \"US\",\n \"address_residential_indicator\": \"no\"\n },\n \"messages\": []\n }\n]"
}
]
}
