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
Parameter Type Description


                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


                GET: maxCands

Integer The maximum number of candidates to return. Optional. Must be an integer value. Default = 1.
matchMode String Match modes determine the leniency used to make a match between the input address and the reference data.

STANDARD, default

RELAXED

CLOSE

Note: When searching World Places Interactive, only Standard mode is supported.

originXY

List Double XY coordinates of the origin address.
{
"preferences" : 
  {
  "originXY" : [-73.70252500000001, 42.68323]
    },
  "address" : 
  {
  "mainAddressLine" : "350 Jordan Rd"
  }
}


                POST: restrictedSearch

Bounds Enclosed search area from which interactive geocoding responses are derived.
{
"preferences":
     {
     "restrictedSearch": 
	{"northEastXY": [-73.70252500000001,42.68323],
	"southWestXY": [-73.70252500000001,42.68323]
	}
		},
	"address": 
     {
     "mainAddressLine": 
	"350 Jordan Rd"
	}
}


                GET: distance

Double Distance of the radius in which to search for a match. Default is 5


                GET: distanceUnits

String

FEET, METERS, MILES, KILOMETERS,

FOOT, METER, MILE, KILOMETER

Default is MILES.


                POST: clientCoordSysName


                GET: coordSysName

String The coordinate system to use for all point data, in epsg:nnnn format. Default is epsg:4326 (WGS 84).


                POST: matchOnAddressNumber

Boolean
true
A match must be made to the input address number.
false
A match does not need to be made to the input address number. Default.