Chilkat Online Tools

unicodeC / ShipEngine Walkthrough / Parse an Address

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW json;
    HCkHttpResponseW resp;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *v_type;
    const wchar_t *text;
    int start_index;
    int end_index;
    const wchar_t *Value;
    int Line;
    const wchar_t *v_Type;
    const wchar_t *resultName;
    const wchar_t *score;
    const wchar_t *Name;
    const wchar_t *Address_line1;
    const wchar_t *City_locality;
    const wchar_t *State_province;
    const wchar_t *Postal_code;
    const wchar_t *Address_residential_indicator;
    int i;
    int count_i;

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

    http = CkHttpW_Create();

    // 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 Miller’s house at 525 Winchester Blvd in San Jose (that's california, obviously). The zip code there is 95128."
    // }

    json = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(json,L"text",L"I need to send a package to my friend Amanda Miller’s house at 525 Winchester Blvd in San Jose (that's california, obviously). The zip code there is 95128.");

    CkHttpW_SetRequestHeader(http,L"API-Key",L"{{API_KEY}}");
    CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");

    resp = CkHttpW_PostJson3(http,L"https://api.shipengine.com/v1/addresses/recognize",L"application/json",json);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(json);
        return;
    }

    sbResponseBody = CkStringBuilderW_Create();
    CkHttpResponseW_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpResponseW_getStatusCode(resp);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpResponseW_header(resp));
        wprintf(L"Failed.\n");
        CkHttpResponseW_Dispose(resp);
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(json);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    CkHttpResponseW_Dispose(resp);

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

    // {
    //   "score": 0.9710697187242877,
    //   "address": {
    //     "name": "Amanda Miller",
    //     "address_line1": "525 Winchester Blvd",
    //     "city_locality": "San Jose",
    //     "state_province": "CA",
    //     "postal_code": "95128",
    //     "address_residential_indicator": "yes"
    //   },
    //   "entities": [
    //     {
    //       "type": "person",
    //       "score": 0.9519646137063122,
    //       "text": "Amanda Miller",
    //       "start_index": 38,
    //       "end_index": 50,
    //       "result": {
    //         "value": "Amanda Miller"
    //       }
    //     },
    //     {
    //       "type": "residential_indicator",
    //       "score": 0.9519646137063122,
    //       "text": "house",
    //       "start_index": 54,
    //       "end_index": 58,
    //       "result": {
    //         "value": "yes"
    //       }
    //     },
    //     {
    //       "type": "address_line",
    //       "score": 0.9805313966503588,
    //       "text": "525 Winchester Blvd",
    //       "start_index": 63,
    //       "end_index": 81,
    //       "result": {
    //         "line": 1,
    //         "value": "525 Winchester Blvd"
    //       }
    //     },
    //     {
    //       "type": "number",
    //       "score": 0.9805313966503588,
    //       "text": "525",
    //       "start_index": 63,
    //       "end_index": 65,
    //       "result": {
    //         "type": "cardinal",
    //         "value": 525
    //       }
    //     },
    //     {
    //       "type": "city_locality",
    //       "score": 0.9805313966503588,
    //       "text": "San Jose",
    //       "start_index": 86,
    //       "end_index": 93,
    //       "result": {
    //         "value": "San Jose"
    //       }
    //     },
    //     {
    //       "type": "state_province",
    //       "score": 0.9805313966503588,
    //       "text": "california",
    //       "start_index": 103,
    //       "end_index": 112,
    //       "result": {
    //         "name": "California",
    //         "value": "CA"
    //       }
    //     },
    //     {
    //       "type": "postal_code",
    //       "score": 0.9519646137063122,
    //       "text": "95128",
    //       "start_index": 149,
    //       "end_index": 153,
    //       "result": {
    //         "value": "95128"
    //       }
    //     }
    //   ]
    // }

    // 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.

    score = CkJsonObjectW_stringOf(jResp,L"score");
    Name = CkJsonObjectW_stringOf(jResp,L"address.name");
    Address_line1 = CkJsonObjectW_stringOf(jResp,L"address.address_line1");
    City_locality = CkJsonObjectW_stringOf(jResp,L"address.city_locality");
    State_province = CkJsonObjectW_stringOf(jResp,L"address.state_province");
    Postal_code = CkJsonObjectW_stringOf(jResp,L"address.postal_code");
    Address_residential_indicator = CkJsonObjectW_stringOf(jResp,L"address.address_residential_indicator");
    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"entities");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        v_type = CkJsonObjectW_stringOf(jResp,L"entities[i].type");
        score = CkJsonObjectW_stringOf(jResp,L"entities[i].score");
        text = CkJsonObjectW_stringOf(jResp,L"entities[i].text");
        start_index = CkJsonObjectW_IntOf(jResp,L"entities[i].start_index");
        end_index = CkJsonObjectW_IntOf(jResp,L"entities[i].end_index");
        Value = CkJsonObjectW_stringOf(jResp,L"entities[i].result.value");
        Line = CkJsonObjectW_IntOf(jResp,L"entities[i].result.line");
        v_Type = CkJsonObjectW_stringOf(jResp,L"entities[i].result.type");
        resultName = CkJsonObjectW_stringOf(jResp,L"entities[i].result.name");
        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(json);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(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 Miller’s house at 525 Winchester Blvd in San Jose (that\'s california, obviously). The zip code there is 95128."
}'
https://api.shipengine.com/v1/addresses/recognize

Postman Collection Item JSON

{
  "name": "Parse an Address",
  "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 Miller’s house at 525 Winchester Blvd in San Jose (that's california, obviously). The zip code there is 95128.\"\n}"
    },
    "url": {
      "raw": "https://api.shipengine.com/v1/addresses/recognize",
      "protocol": "https",
      "host": [
        "api",
        "shipengine",
        "com"
      ],
      "path": [
        "v1",
        "addresses",
        "recognize"
      ]
    },
    "description": "This request shows how to pass unstructured text to ShipEngine that contains address information. ShipEngine will recognize any address-related parts of the text and give you back an `address` object."
  },
  "response": [
    {
      "name": "Parse an Address",
      "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 Miller’s house at 525 Winchester Blvd in San Jose (that's california, obviously). The zip code there is 95128.\"\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 14:59:19 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.9710697187242877,\n    \"address\": {\n        \"name\": \"Amanda Miller\",\n        \"address_line1\": \"525 Winchester Blvd\",\n        \"city_locality\": \"San Jose\",\n        \"state_province\": \"CA\",\n        \"postal_code\": \"95128\",\n        \"address_residential_indicator\": \"yes\"\n    },\n    \"entities\": [\n        {\n            \"type\": \"person\",\n            \"score\": 0.9519646137063122,\n            \"text\": \"Amanda Miller\",\n            \"start_index\": 38,\n            \"end_index\": 50,\n            \"result\": {\n                \"value\": \"Amanda Miller\"\n            }\n        },\n        {\n            \"type\": \"residential_indicator\",\n            \"score\": 0.9519646137063122,\n            \"text\": \"house\",\n            \"start_index\": 54,\n            \"end_index\": 58,\n            \"result\": {\n                \"value\": \"yes\"\n            }\n        },\n        {\n            \"type\": \"address_line\",\n            \"score\": 0.9805313966503588,\n            \"text\": \"525 Winchester Blvd\",\n            \"start_index\": 63,\n            \"end_index\": 81,\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\": 63,\n            \"end_index\": 65,\n            \"result\": {\n                \"type\": \"cardinal\",\n                \"value\": 525\n            }\n        },\n        {\n            \"type\": \"city_locality\",\n            \"score\": 0.9805313966503588,\n            \"text\": \"San Jose\",\n            \"start_index\": 86,\n            \"end_index\": 93,\n            \"result\": {\n                \"value\": \"San Jose\"\n            }\n        },\n        {\n            \"type\": \"state_province\",\n            \"score\": 0.9805313966503588,\n            \"text\": \"california\",\n            \"start_index\": 103,\n            \"end_index\": 112,\n            \"result\": {\n                \"name\": \"California\",\n                \"value\": \"CA\"\n            }\n        },\n        {\n            \"type\": \"postal_code\",\n            \"score\": 0.9519646137063122,\n            \"text\": \"95128\",\n            \"start_index\": 149,\n            \"end_index\": 153,\n            \"result\": {\n                \"value\": \"95128\"\n            }\n        }\n    ]\n}"
    }
  ]
}