Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// 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 S Winchester Blvd",
// "city_locality": "San Jose",
// "state_province": "CA",
// "postal_code": "95128",
// "country_code": "USA"
// }
// ]
loJarr = createobject("CkJsonArray")
loJarr.AddObjectAt(-1)
loJsonObj_1 = loJarr.ObjectAt(loJarr.Size - 1)
loJsonObj_1.UpdateString("address_line1","525 S Winchester Blvd")
loJsonObj_1.UpdateString("city_locality","San Jose")
loJsonObj_1.UpdateString("state_province","CA")
loJsonObj_1.UpdateString("postal_code","95128")
loJsonObj_1.UpdateString("country_code","USA")
release loJsonObj_1
loHttp.SetRequestHeader("API-Key","{{API_KEY}}")
loHttp.SetRequestHeader("Content-Type","application/json")
loSbRequestBody = createobject("CkStringBuilder")
loJarr.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("POST","https://api.shipengine.com/v1/addresses/validate",loSbRequestBody,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJarr
release loSbRequestBody
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJarrResp = createobject("CkJsonArray")
loJarrResp.LoadSb(loSbResponseBody)
loJarrResp.EmitCompact = .F.
? "Response Body:"
? loJarrResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJarr
release loSbRequestBody
release loSbResponseBody
release loJarrResp
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// [
// {
// "status": "unverified",
// "original_address": {
// "name": null,
// "phone": null,
// "company_name": null,
// "address_line1": "525 S Winchester Blvd",
// "address_line2": null,
// "address_line3": null,
// "city_locality": "San Jose",
// "state_province": "CA",
// "postal_code": "95128",
// "country_code": "USA",
// "address_residential_indicator": "unknown"
// },
// "matched_address": null,
// "messages": [
// {
// "code": "a1005",
// "message": "Length of property 'country_code' must equal exactly 2",
// "type": "error",
// "detail_code": "country_invalid_length"
// },
// {
// "code": "a1001",
// "message": "country_code is not currently a supported country, please check the documentation for acceptable 2-letter country codes.",
// "type": "error",
// "detail_code": "unsupported_country"
// }
// ]
// }
// ]
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
i = 0
lnCount_i = loJarrResp.Size
do while i < lnCount_i
loJson = loJarrResp.ObjectAt(i)
lcStatus = loJson.StringOf("status")
lcName = loJson.StringOf("original_address.name")
lcPhone = loJson.StringOf("original_address.phone")
lcCompany_name = loJson.StringOf("original_address.company_name")
lcAddress_line1 = loJson.StringOf("original_address.address_line1")
lcAddress_line2 = loJson.StringOf("original_address.address_line2")
lcAddress_line3 = loJson.StringOf("original_address.address_line3")
lcCity_locality = loJson.StringOf("original_address.city_locality")
lcState_province = loJson.StringOf("original_address.state_province")
lcPostal_code = loJson.StringOf("original_address.postal_code")
lcCountry_code = loJson.StringOf("original_address.country_code")
lcAddress_residential_indicator = loJson.StringOf("original_address.address_residential_indicator")
lcMatched_address = loJson.StringOf("matched_address")
j = 0
lnCount_j = loJson.SizeOfArray("messages")
do while j < lnCount_j
loJson.J = j
lcCode = loJson.StringOf("messages[j].code")
lcMessage = loJson.StringOf("messages[j].message")
lcV_type = loJson.StringOf("messages[j].type")
lcDetail_code = loJson.StringOf("messages[j].detail_code")
j = j + 1
enddo
release loJson
i = i + 1
enddo
release loHttp
release loJarr
release loSbRequestBody
release loSbResponseBody
release loJarrResp
Curl Command
curl -X POST
-H "API-Key: {{API_KEY}}"
-H "Content-Type: application/json"
-d '[
{
"address_line1": "525 S Winchester Blvd",
"city_locality": "San Jose",
"state_province": "CA",
"postal_code": "95128",
"country_code": "USA"
}
]'
https://api.shipengine.com/v1/addresses/validate
Postman Collection Item JSON
{
"name": "Validate an address (unverified)",
"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 S Winchester Blvd\",\n\t\t\"city_locality\": \"San Jose\",\n\t\t\"state_province\": \"CA\",\n\t\t\"postal_code\": \"95128\",\n\t\t\"country_code\": \"USA\"\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 cannot be verified. The `status` field is `unverified`, and the `messages` array lists the problems with the address."
},
"response": [
{
"name": "Validate an address (unverified)",
"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 S Winchester Blvd\",\n\t\t\"city_locality\": \"San Jose\",\n\t\t\"state_province\": \"CA\",\n\t\t\"postal_code\": \"95128\",\n\t\t\"country_code\": \"USA\"\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": "Tue, 22 Oct 2019 20:28:48 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "951"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "118b96e8-1e29-4ded-ba33-62a661e55038"
}
],
"cookie": [
],
"body": "[\n {\n \"status\": \"unverified\",\n \"original_address\": {\n \"name\": null,\n \"phone\": null,\n \"company_name\": null,\n \"address_line1\": \"525 S Winchester Blvd\",\n \"address_line2\": null,\n \"address_line3\": null,\n \"city_locality\": \"San Jose\",\n \"state_province\": \"CA\",\n \"postal_code\": \"95128\",\n \"country_code\": \"USA\",\n \"address_residential_indicator\": \"unknown\"\n },\n \"matched_address\": null,\n \"messages\": [\n {\n \"code\": \"a1005\",\n \"message\": \"Length of property 'country_code' must equal exactly 2\",\n \"type\": \"error\",\n \"detail_code\": \"country_invalid_length\"\n },\n {\n \"code\": \"a1001\",\n \"message\": \"country_code is not currently a supported country, please check the documentation for acceptable 2-letter country codes.\",\n \"type\": \"error\",\n \"detail_code\": \"unsupported_country\"\n }\n ]\n }\n]"
}
]
}
