Preferences - 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

The input address may contain some or all of the following address elements.

Note: Some parameters are identified with POST and GET. Those with both indicate a difference in the parameter name. The parameters with no POST and GET are used for either request type using the same parameter name. Other parameters are either POST or GET as marked.
Preference Type Description
streetOffset Double The offset distance from the street segments. The distance is in the units you specify in the streetOffsetUnits preference. Default value = 7 meters.

The offset distance is used in street-level geocoding to prevent the geocode from being in the middle of a street. It compensates for the fact that street-level geocoding returns a latitude and longitude point in the center of the street where the address is located.

For example, an offset of 50 feet means that the geocode will represent a point 50 feet back from the center of the street. The distance is calculated perpendicular to the portion of the street segment for the address. Offset is also used to prevent addresses across the street from each other from being given the same point.
streetOffsetUnits String Unit of measurement for the street offset. One of the following: Feet, Meters (default).
cornerOffset Double Distance to offset the street end points in street-level matching. The distance is in the units you specify in the cornerOffsetUnits preference. This value is used to prevent addresses at street corners from being given the same geocode as the intersection. Defines the offset position of the geocoded point with respect to the corner. Default value = 7 meters.

The following diagram compares the end points of a street to offset end points.

cornerOffsetUnits String Specifies the unit of measurement for the corner offset. One of the following: Feet, Meters (default).

POST: returnAllCandidateInfo

Boolean Specifies whether to return all available information for each candidate.
true
Return all available information for each candidate.
false
Do not return all available information for each candidate. Default.

POST: maxReturnedCandidates

Integer The maximum number of candidates to return. Optional. Must be an integer value. Default = 1.

distance

Integer Distance of the radius in which to search for a match to the input coordinates. This value can be specified in either feet or meters.

distanceUnits

String

FEET,METERS,MILES,KILOMETERS,

FOOT,METER,MILE,KILOMETER

POST: clientCoordSysName

GET: coordSysName

String Specifies the coordinate system that you want to convert the geometry to. The format must be the European Petroleum Survey Group (EPSG) code or the SRID code. Default = EPSG:4326.

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

POST: returnAllCustomFields

Boolean
true
Return all of the custom fields for the candidate.
false
Return only the standard set of fields for the candidate. Default.

POST: returnedCustomFieldKeys

List<String> Specifies a list of keys that represent the custom fields to be returned in the candidate's customFields output. To specify multiple key/value pairs for a country, use spaces to separate the names of the custom fields to be returned. Custom fields vary by country. For example: “CTYST_KEY” or “DATATYPE”. Default: empty.

POST: returnStreetAddressFields

Boolean
true
Return all of the individual street fields that make up the formattedStreetAddress field separately, as follows:
  • MAIN_ADDRESS
  • THOROUGHFARE_TYPE
  • ADDRESS_ID
  • PRE_ADDRESS
  • POST_ADDRESS
  • PRE_DIRECTIONAL
  • POST_DIRECTIONAL
false
Do not return the individual street fields separately; return these values in the formattedStreetAddress field. Default.

POST: returnUnitInformation

Boolean
true
Where available, return unit type and unit value information separately in the unitType and unitValue fields, as well as in the formattedStreetAddress field.
false
Where available, return unit type and unit value information only in the formattedStreetAddress field. Default.