Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_V_type
string ls_Text
integer li_Start_index
integer li_End_index
string ls_Value
integer li_Line
string ls_V_Type
string ls_Score
string ls_Address_line1
string ls_City_locality
string ls_Postal_code
string ls_Address_residential_indicator
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "text": "I need to send a package to my friend Amanda. Her last name is Miller, btw. Her office address is 525 Winchester Blvd. That's in California for sure. Pretty sure it's San Jose, but I'm only like 90% sure about that. Pretty sure the zip code is something like 95128, or maybe 90210."
// }
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_Json.UpdateString("text","I need to send a package to my friend Amanda. Her last name is Miller, btw. Her office address is 525 Winchester Blvd. That's in California for sure. Pretty sure it's San Jose, but I'm only like 90% sure about that. Pretty sure the zip code is something like 95128, or maybe 90210.")
loo_Http.SetRequestHeader("API-Key","{{API_KEY}}")
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_Resp = loo_Http.PostJson3("https://api.shipengine.com/v1/addresses/recognize","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
return
end if
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "score": 0.7503696513496741,
// "address": {
// "address_line1": "525 Winchester Blvd",
// "city_locality": "Miller",
// "postal_code": "90210",
// "address_residential_indicator": "no"
// },
// "entities": [
// {
// "type": "city_locality",
// "score": 0.4792571878834418,
// "text": "Miller",
// "start_index": 63,
// "end_index": 68,
// "result": {
// "value": "Miller"
// }
// },
// {
// "type": "residential_indicator",
// "score": 0.9519646137063122,
// "text": "office",
// "start_index": 80,
// "end_index": 85,
// "result": {
// "value": "no"
// }
// },
// {
// "type": "address_line",
// "score": 0.6082904353940255,
// "text": "525 Winchester Blvd",
// "start_index": 98,
// "end_index": 116,
// "result": {
// "line": 1,
// "value": "525 Winchester Blvd"
// }
// },
// {
// "type": "number",
// "score": 0.9805313966503588,
// "text": "525",
// "start_index": 98,
// "end_index": 100,
// "result": {
// "type": "cardinal",
// "value": 525
// }
// },
// {
// "type": "city_locality",
// "score": 0.4792571878834418,
// "text": "San Jose",
// "start_index": 167,
// "end_index": 174,
// "result": {
// "value": "San Jose"
// }
// },
// {
// "type": "number",
// "score": 0.9805313966503588,
// "text": "90%",
// "start_index": 195,
// "end_index": 197,
// "result": {
// "type": "percentage",
// "value": 0.9
// }
// },
// {
// "type": "number",
// "score": 0.9805313966503588,
// "text": "95128",
// "start_index": 259,
// "end_index": 263,
// "result": {
// "type": "cardinal",
// "value": 95128
// }
// },
// {
// "type": "postal_code",
// "score": 0.9519646137063122,
// "text": "90210",
// "start_index": 275,
// "end_index": 279,
// "result": {
// "value": "90210"
// }
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_Score = loo_JResp.StringOf("score")
ls_Address_line1 = loo_JResp.StringOf("address.address_line1")
ls_City_locality = loo_JResp.StringOf("address.city_locality")
ls_Postal_code = loo_JResp.StringOf("address.postal_code")
ls_Address_residential_indicator = loo_JResp.StringOf("address.address_residential_indicator")
i = 0
li_Count_i = loo_JResp.SizeOfArray("entities")
do while i < li_Count_i
loo_JResp.I = i
ls_V_type = loo_JResp.StringOf("entities[i].type")
ls_Score = loo_JResp.StringOf("entities[i].score")
ls_Text = loo_JResp.StringOf("entities[i].text")
li_Start_index = loo_JResp.IntOf("entities[i].start_index")
li_End_index = loo_JResp.IntOf("entities[i].end_index")
ls_Value = loo_JResp.StringOf("entities[i].result.value")
li_Line = loo_JResp.IntOf("entities[i].result.line")
ls_V_Type = loo_JResp.StringOf("entities[i].result.type")
i = i + 1
loop
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -X POST
-H "API-Key: {{API_KEY}}"
-H "Content-Type: application/json"
-d '{
"text": "I need to send a package to my friend Amanda. Her last name is Miller, btw. Her office address is 525 Winchester Blvd. That\'s in California for sure. Pretty sure it\'s San Jose, but I\'m only like 90% sure about that. Pretty sure the zip code is something like 95128, or maybe 90210."
}'
https://api.shipengine.com/v1/addresses/recognize
Postman Collection Item JSON
{
"name": "Confidence scores",
"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\"text\": \"I need to send a package to my friend Amanda. Her last name is Miller, btw. Her office address is 525 Winchester Blvd. That's in California for sure. Pretty sure it's San Jose, but I'm only like 90% sure about that. Pretty sure the zip code is something like 95128, or maybe 90210.\"\n}"
},
"url": {
"raw": "https://api.shipengine.com/v1/addresses/recognize",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"addresses",
"recognize"
]
},
"description": "ShipEngine's Parse Address API returns confidence scores for each entity that it recognizes, as well as for the address as a whole. You can use these scores to determine whether the address is safe to use or requires additional validation or information from the user."
},
"response": [
{
"name": "Confidence scores",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"text\": \"I need to send a package to my friend Amanda. Her last name is Miller, btw. Her office address is 525 Winchester Blvd. That's in California for sure. Pretty sure it's San Jose, but I'm only like 90% sure about that. Pretty sure the zip code is something like 95128, or maybe 90210.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.shipengine.com/v1/addresses/recognize",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"addresses",
"recognize"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 18 Sep 2019 16:18:21 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "content-encoding",
"value": "gzip"
}
],
"cookie": [
],
"body": "{\n \"score\": 0.7503696513496741,\n \"address\": {\n \"address_line1\": \"525 Winchester Blvd\",\n \"city_locality\": \"Miller\",\n \"postal_code\": \"90210\",\n \"address_residential_indicator\": \"no\"\n },\n \"entities\": [\n {\n \"type\": \"city_locality\",\n \"score\": 0.4792571878834418,\n \"text\": \"Miller\",\n \"start_index\": 63,\n \"end_index\": 68,\n \"result\": {\n \"value\": \"Miller\"\n }\n },\n {\n \"type\": \"residential_indicator\",\n \"score\": 0.9519646137063122,\n \"text\": \"office\",\n \"start_index\": 80,\n \"end_index\": 85,\n \"result\": {\n \"value\": \"no\"\n }\n },\n {\n \"type\": \"address_line\",\n \"score\": 0.6082904353940255,\n \"text\": \"525 Winchester Blvd\",\n \"start_index\": 98,\n \"end_index\": 116,\n \"result\": {\n \"line\": 1,\n \"value\": \"525 Winchester Blvd\"\n }\n },\n {\n \"type\": \"number\",\n \"score\": 0.9805313966503588,\n \"text\": \"525\",\n \"start_index\": 98,\n \"end_index\": 100,\n \"result\": {\n \"type\": \"cardinal\",\n \"value\": 525\n }\n },\n {\n \"type\": \"city_locality\",\n \"score\": 0.4792571878834418,\n \"text\": \"San Jose\",\n \"start_index\": 167,\n \"end_index\": 174,\n \"result\": {\n \"value\": \"San Jose\"\n }\n },\n {\n \"type\": \"number\",\n \"score\": 0.9805313966503588,\n \"text\": \"90%\",\n \"start_index\": 195,\n \"end_index\": 197,\n \"result\": {\n \"type\": \"percentage\",\n \"value\": 0.9\n }\n },\n {\n \"type\": \"number\",\n \"score\": 0.9805313966503588,\n \"text\": \"95128\",\n \"start_index\": 259,\n \"end_index\": 263,\n \"result\": {\n \"type\": \"cardinal\",\n \"value\": 95128\n }\n },\n {\n \"type\": \"postal_code\",\n \"score\": 0.9519646137063122,\n \"text\": \"90210\",\n \"start_index\": 275,\n \"end_index\": 279,\n \"result\": {\n \"value\": \"90210\"\n }\n }\n ]\n}"
}
]
}
