Geo Addressing API Objects - geo_addressing_sdk - 5.0

MatchType

*To return POI values, configure a dataset that contains points of interest (POI) data

EXACT or NONE

• geocode

• reverseGeocode
• interactive
• keyLookup

"GB"

"GBR"

"826"

• string
• number
• integer
• boolean
• array
• object

Unit of measurement for the search radius: FOOT, METER, MILE, KILOMETER. Default is METER (case-sensitive).

Example
"factoryDescription": {
"label": "ggs",
"featureSpecific": {
"VERIFY": "global_locator"
}
}

Features include:

"GEOCODE"
"PARSE"
"VERIFY"
"REVERSE_GEOCODE"
"INTERACTIVE"
"LOOKUP"

Features include:

"GEOCODE"
"PARSE"
"VERIFY"
"REVERSE_GEOCODE"
"INTERACTIVE"
"LOOKUP"

149.19290021000003,
-31.276491389162288

LookupType controls what type of information will be requested. For example,

• "PB_KEY" for USA data
• "GNAF_PID for AUS G-NAF data

• "PB_KEY" for USA data
• "GNAF_PID for AUS G-NAF data

Describes the level of address match. Possible values:

• ADDRESS
• STREET
• ADMIN
• POBOX
• POI
• NOMATCH

Indicates how well the address was parsed. Currently, returns a "0".

Latitude in degrees. For example: 43.643469

Longitude in degrees. For example: -79.391165

Exception message. Returns the message returned from the underlying exception.

"PRIME MINISTER& FIRST LORD OF THE TREASURY, 10 DOWNING STREET, LONDON, SW1A 2AA"

or "630 168TH ST, NEW YORK NY 10032-3725"

"PRIME MINISTER& FIRST LORD OF THE TREASURY",
"10 DOWNING STREET",
"LONDON",
"SW1A 2AA",
"UNITED KINGDOM"

Object

true

Return a geographic centroid when an address-level centroid cannot be determined. Default.

false

Do not return a geographic centroid when an address-level centroid cannot be determined.

This lets the user control which additional fields they want to have returned if they do not want to return all info.

{
  "preferences" : {
    "returnOfAdditionalFields " : ["PB_KEY"]
  }
}

Specify the coordinate reference system in the format codespace:code.

Distance

{
"preferences" : 
  {
  "originXY" : [-73.70252500000001, 42.68323]
    },
  "address" : 
  {
  "mainAddressLine" : "350 Jordan Rd"
  }
}

true

Return a post code centroid when an address-level centroid cannot be determined. Default.

false

Do not return a post code centroid when an address-level centroid cannot be determined.

Distance

true

Return all available information for each candidate.

false

Do not return all available information for each candidate. Default.

EXACT

Requires a very tight match. This restrictive mode generates the fewest match candidates, which decreases the processing time.

STANDARD

Requires a close match and generates a moderate number of match candidates. Default.

RELAXED

Allows a loose match and generates the most match candidates, which increases the processing time and results in more multiple matches.

CUSTOM

Provides the capability for you to define the matching criteria by setting MustMatch fields; however, you can only set the MustMatch fields using a POST request. For a GET request, the MustMatch default values are used.

Note: For the list of MustMatch fields for custom preference, see, Custom Preferences Geocode Service.

Indicates the geocode type to be performed.

ADDRESS

Geocode to a street address. Default.

GEOGRAPHIC

Geocode to the geographic centroid of a city or state.

POSTAL

Geocode to a postal code.

Single-line request:

"10 downing street london SW1A 2AA"

"10 DOWNING STREET",
"LONDON, SW1A 2AA"

"10" or "630"

"New York" or "Maharashtra".

"Douglas County" or "West Mumbai".

"New York City"

"Vazira" or "Manhattan"

"Highlands Ranch"

"80125"

"8012"

"PRIME MINISTER& FIRST LORD OF THE TREASURY"

"PRIME MINISTER& FIRST LORD OF THE TREASURY, 10 DOWNING STREET, LONDON, SW1A 2AA"

or "630 168TH ST, NEW YORK NY 10032-3725"

"10 DOWNING STREET" or "630 W 168TH ST"

"LONDON SW1A 2AA" or "NEW YORK, NY 10032-3725"

"10" or "630"

"New York" or "Maharashtra".

"Douglas County" or "West Mumbai".

"New York City"

""

""

"Vazira" or "Manhattan"

"80125"

"8012"

"PRIME MINISTER& FIRST LORD OF THE TREASURY"

"FRASER RIVER" or "168TH"

"PRIME MINISTER& FIRST LORD OF THE TREASURY",
"10 DOWNING STREET",
"LONDON",
"SW1A 2AA",
"UNITED KINGDOM"

Describes the location type and coordinates.

Shows how the address was parsed, using the specified addressing process.

Returns additional information about the address; see Custom Output Fields (All Fields).

<Response> array