Address Autocomplete Service Request

Address Autocomplete Request structure

The Address Autocomplete Request includes Preferences and Addresses.

Table 1. Request
Parameter Description Example Value
preferences Options supported by the Address Geocode Service which includes a variety of settings for match mode, geocode type, candidates returned, fallbacks, offsets, match address elements, ranges information and more. maxResultss: The maximum number of candidates to return. Optional. Must be an integer value.Default = 1.
addresses List of addresses to be processed.

addressLines:

Requested address, based on the country's addressing standard.

Single-line request:

"10 downing street london SW1A 2AA"

Multi-line request:

"10 DOWNING STREET",

"LONDON, SW1A 2AA"

Below is a sample Address Autocomplete Request:

 {
  "preferences": {
    "maxResults": 2,
    "returnAllInfo": true,
    "factoryDescription": {
      "label": "",
      "featureSpecific": {}
    },
    "clientLocale": "",
    "clientCoordSysName": "",
    "distance": {
      "value": 150,
      "distanceUnit": "METER"
    },
    "streetOffset": {
      "value": 7,
      "distanceUnit": "METER"
    },
    "cornerOffset": {
      "value": 7,
      "distanceUnit": "METER"
    },
    "fallbackToGeographic": false,
    "fallbackToPostal": false,
    "matchMode": "",
    "returnOfAdditionalFields": false,
    "originXY": [],
    "customPreferences": {}
  },
  "address": {
    "addressLines": [
      "350 Jordan"
    ],
    "country": "USA",
    "addressNumber": "",
    "admin1": "",
    "admin2": "",
    "city": "",
    "borough": "",
    "neighborhood": "",
    "suburb": "",
    "postalCode": "",
    "postalCodeExt": "",
    "placeName": "",
    "street": "",
    "building": "",
    "floor": "",
    "room": "",
    "unit": "",
    "unitType": ""
  }
}
You can try this in the Geo Addressing SDK Sample application (http://{server}:{port}/{context}/):
  1. Click Addressing > Autocomplete.
  2. Enter a complete Address and specify a Country.
    • If multiline entry is needed, select the Show parsed Fields option.
  3. In the Request, go to the "preferences" section and enter a value on the "label" line.
  4. Click Submit and view the response.