Address Autocomplete Service Response - geo_addressing_sdk - 5.0

Geo Addressing SDK Developer Guide

Product type
Software
Portfolio
Locate
Product family
Geo Addressing
Product
Geo Addressing SDK
Version
5.0
Language
English
Product name
Geo Addressing SDK
Title
Geo Addressing SDK Developer Guide
Copyright
2023
First publish date
2007
ft:lastEdition
2024-07-12
ft:lastPublication
2024-07-12T13:44:57.839102

Within the Addressing REST API, a request to the Autocomplete Service returns a list of results.

Response Structure

Below are the Response fields returned:
Table 1. Request
Field Type Description
errorMessage String Exception message. The error message returned from the service with an error code
status Status Status of the response.
results <Result array List of results based on the specified criteria.

Addressing: Autocomplete Example

In the Sample application, do the following:

  1. Navigate to Addressing v1 > Autocomplete.
  2. Enter the Address "10 downing street london SW1A 2AA" and "GBR" as the Country.
  3. Click Submit and review the Response
Below is a sample response for Address Autocomplete.
{
  "response": {
    "status": "OK",
    "predictions": [
      {
        "prediction": "350 Jordan Ave, Montoursville, PA 17754",
        "distance": {
          "value": 0,
          "distanceUnit": "METER"
        },
        "address": {
          "formattedAddress": "350 Jordan Ave, Montoursville PA 17754",
          "formattedStreetAddress": "350 Jordan Ave",
          "formattedLocationAddress": "Montoursville, PA 17754",
          "addressNumber": "350",
          "country": {
            "isoAlpha3Code": "USA"
          },
          "admin1": {
            "longName": "PA",
            "shortName": "PA"
          },
          "admin2": {},
          "city": {
            "longName": "Montoursville",
            "shortName": "Montoursville"
          },
          "neighborhood": {},
          "postalCode": "17754",
          "street": "Jordan Ave"
        },
        "addressLines": [
          "350 Jordan Ave",
          "Montoursville PA 17754"
        ],
        "location": {
          "feature": {
            "type": "Feature",
            "properties": {
              "crsName": "epsg:4326"
            },
            "geometry": {
              "type": "Point",
              "coordinates": [
                -76.91419,
                41.246719999999996
              ]
            }
          }
        },
        "explanation": {
          "addressMatch": {
            "description": [
              {
                "label": "placeName",
                "matchType": "NONE"
              },
              {
                "label": "addressNumber",
                "matchType": "EXACT",
                "matchedSubstring": "350"
              },
              {
                "label": "admin1",
                "matchType": "NONE"
              },
              {
                "label": "admin2",
                "matchType": "NONE"
              },
              {
                "label": "city",
                "matchType": "NONE"
              },
              {
                "label": "neighborhood",
                "matchType": "NONE"
              },
              {
                "label": "suburb",
                "matchType": "NONE"
              },
              {
                "label": "street",
                "matchType": "PARTIAL",
                "matchedSubstring": "JORDAN"
              },
              {
                "label": "postalCode",
                "matchType": "NONE"
              },
              {
                "label": "streetType",
                "matchType": "NONE"
              },
              {
                "label": "postalCodeExt",
                "matchType": "NONE"
              },
              {
                "label": "streetDirectional",
                "matchType": "NONE"
              }
            ]
          },
          "source": {
            "label": "ggs"
          }
        },
        "customFields": {
          "PB_KEY": "P0000JCAW989",
          "DISTANCE": "-0.0",
          "FROM_CUSTOM_DATASET": "false",
          "MATCHED_FROM_ADDRESSNUMBER": "350",
          "MATCHED_FROM_STREETNAME": "JORDAN",
          "ADDRESS_NUMBER_FROM": "350",
          "POSTAL_VERIFIED": "YES",
          "FORMATTED_STRING": "350 Jordan Ave, Montoursville, PA 17754",
          "RECORD_TYPE": "2",
          "FEATUREID": "102759609",
          "ZIP4": "2210",
          "DISTANCE_UNIT": "METERS"
        }
      },
      {
        "prediction": "350 S Jordan Ave, San Jacinto, CA 92583",
        "distance": {
          "value": 0,
          "distanceUnit": "METER"
        },
        "address": {
          "formattedAddress": "350 S Jordan Ave, San Jacinto CA 92583",
          "formattedStreetAddress": "350 S Jordan Ave",
          "formattedLocationAddress": "San Jacinto, CA 92583",
          "addressNumber": "350",
          "country": {
            "isoAlpha3Code": "USA"
          },
          "admin1": {
            "longName": "CA",
            "shortName": "CA"
          },
          "admin2": {},
          "city": {
            "longName": "San Jacinto",
            "shortName": "San Jacinto"
          },
          "neighborhood": {},
          "postalCode": "92583",
          "street": "S Jordan Ave"
        },
        "addressLines": [
          "350 S Jordan Ave",
          "San Jacinto CA 92583"
        ],
        "location": {
          "feature": {
            "type": "Feature",
            "properties": {
              "crsName": "epsg:4326"
            },
            "geometry": {
              "type": "Point",
              "coordinates": [
                -116.95680999999999,
                33.782465
              ]
            }
          }
        },
        "explanation": {
          "addressMatch": {
            "description": [
              {
                "label": "placeName",
                "matchType": "NONE"
              },
              {
                "label": "addressNumber",
                "matchType": "EXACT",
                "matchedSubstring": "350"
              },
              {
                "label": "admin1",
                "matchType": "NONE"
              },
              {
                "label": "admin2",
                "matchType": "NONE"
              },
              {
                "label": "city",
                "matchType": "NONE"
              },
              {
                "label": "neighborhood",
                "matchType": "NONE"
              },
              {
                "label": "suburb",
                "matchType": "NONE"
              },
              {
                "label": "street",
                "matchType": "PARTIAL",
                "matchedSubstring": "JORDAN"
              },
              {
                "label": "postalCode",
                "matchType": "NONE"
              },
              {
                "label": "streetType",
                "matchType": "NONE"
              },
              {
                "label": "postalCodeExt",
                "matchType": "NONE"
              },
              {
                "label": "streetDirectional",
                "matchType": "NONE"
              }
            ]
          },
          "source": {
            "label": "ggs"
          }
        },
        "customFields": {
          "PB_KEY": "P00002SZL9FS",
          "DISTANCE": "-0.0",
          "FROM_CUSTOM_DATASET": "false",
          "MATCHED_FROM_ADDRESSNUMBER": "350",
          "MATCHED_FROM_STREETNAME": "JORDAN",
          "ADDRESS_NUMBER_FROM": "350",
          "POSTAL_VERIFIED": "YES",
          "FORMATTED_STRING": "350 S Jordan Ave, San Jacinto, CA 92583",
          "RECORD_TYPE": "2",
          "FEATUREID": "106396168",
          "ZIP4": "3512",
          "DISTANCE_UNIT": "METERS"
        }
      }
    ]
  }
}