unicodeCpp / ShipEngine Walkthrough / Validate an address (incomplete)
Back to Collection Items
#include <CkHttpW.h>
#include <CkJsonArrayW.h>
#include <CkJsonObjectW.h>
#include <CkStringBuilderW.h>
#include <CkHttpResponseW.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttpW http;
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": "525 Winchester",
// "postal_code": "95128",
// "country_code": "US"
// }
// ]
CkJsonArrayW jarr;
jarr.AddObjectAt(-1);
CkJsonObjectW *jsonObj_1 = jarr.ObjectAt(jarr.get_Size() - 1);
jsonObj_1->UpdateString(L"address_line1",L"525 Winchester");
jsonObj_1->UpdateString(L"postal_code",L"95128");
jsonObj_1->UpdateString(L"country_code",L"US");
delete jsonObj_1;
http.SetRequestHeader(L"API-Key",L"{{API_KEY}}");
http.SetRequestHeader(L"Content-Type",L"application/json");
CkStringBuilderW sbRequestBody;
jarr.EmitSb(sbRequestBody);
CkHttpResponseW *resp = http.PTextSb(L"POST",L"https://api.shipengine.com/v1/addresses/validate",sbRequestBody,L"utf-8",L"application/json",false,false);
if (http.get_LastMethodSuccess() == false) {
wprintf(L"%s\n",http.lastErrorText());
return;
}
CkStringBuilderW sbResponseBody;
resp->GetBodySb(sbResponseBody);
CkJsonArrayW jarrResp;
jarrResp.LoadSb(sbResponseBody);
jarrResp.put_EmitCompact(false);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",jarrResp.emit());
int respStatusCode = resp->get_StatusCode();
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",resp->header());
wprintf(L"Failed.\n");
delete resp;
return;
}
delete resp;
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
CkJsonObjectW *json = 0;
const wchar_t *status = 0;
const wchar_t *Name = 0;
const wchar_t *Phone = 0;
const wchar_t *Company_name = 0;
const wchar_t *Address_line1 = 0;
const wchar_t *Address_line2 = 0;
const wchar_t *Address_line3 = 0;
const wchar_t *City_locality = 0;
const wchar_t *State_province = 0;
const wchar_t *Postal_code = 0;
const wchar_t *Country_code = 0;
const wchar_t *Address_residential_indicator = 0;
const wchar_t *matched_addressName = 0;
const wchar_t *matched_addressPhone = 0;
const wchar_t *matched_addressCompany_name = 0;
const wchar_t *matched_addressAddress_line1 = 0;
const wchar_t *matched_addressAddress_line2 = 0;
const wchar_t *matched_addressAddress_line3 = 0;
const wchar_t *matched_addressCity_locality = 0;
const wchar_t *matched_addressState_province = 0;
const wchar_t *matched_addressPostal_code = 0;
const wchar_t *matched_addressCountry_code = 0;
const wchar_t *matched_addressAddress_residential_indicator = 0;
int j;
int count_j;
int i = 0;
int count_i = jarrResp.get_Size();
while (i < count_i) {
json = jarrResp.ObjectAt(i);
status = json->stringOf(L"status");
Name = json->stringOf(L"original_address.name");
Phone = json->stringOf(L"original_address.phone");
Company_name = json->stringOf(L"original_address.company_name");
Address_line1 = json->stringOf(L"original_address.address_line1");
Address_line2 = json->stringOf(L"original_address.address_line2");
Address_line3 = json->stringOf(L"original_address.address_line3");
City_locality = json->stringOf(L"original_address.city_locality");
State_province = json->stringOf(L"original_address.state_province");
Postal_code = json->stringOf(L"original_address.postal_code");
Country_code = json->stringOf(L"original_address.country_code");
Address_residential_indicator = json->stringOf(L"original_address.address_residential_indicator");
matched_addressName = json->stringOf(L"matched_address.name");
matched_addressPhone = json->stringOf(L"matched_address.phone");
matched_addressCompany_name = json->stringOf(L"matched_address.company_name");
matched_addressAddress_line1 = json->stringOf(L"matched_address.address_line1");
matched_addressAddress_line2 = json->stringOf(L"matched_address.address_line2");
matched_addressAddress_line3 = json->stringOf(L"matched_address.address_line3");
matched_addressCity_locality = json->stringOf(L"matched_address.city_locality");
matched_addressState_province = json->stringOf(L"matched_address.state_province");
matched_addressPostal_code = json->stringOf(L"matched_address.postal_code");
matched_addressCountry_code = json->stringOf(L"matched_address.country_code");
matched_addressAddress_residential_indicator = json->stringOf(L"matched_address.address_residential_indicator");
j = 0;
count_j = json->SizeOfArray(L"messages");
while (j < count_j) {
json->put_J(j);
j = j + 1;
}
delete json;
i = i + 1;
}
}
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]"
}
]
}
