Search Area - Spectrum_OnDemand - Latest

Spectrum OnDemand Web Services (REST)

Product type
Software
Portfolio
Verify
Product family
Spectrum
Product
Spectrum > Geocoding > Enterprise Tax
Spectrum > Web Services
Spectrum > Spatial > Spectrum Spatial
Spectrum > Spectrum Platform
Spectrum > Quality > Addressing
Spectrum > Quality > Spectrum Quality
Spectrum > Spatial > Spectrum Spatial Insights
Spectrum > Discovery
Spectrum OnDemand
Spectrum > Dataflow Designer
Spectrum > Spatial > Spectrum Spatial Analyst
Spectrum > Quality > Context Graph
Version
Latest
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (REST)
Copyright
2024
First publish date
2006
ft:lastEdition
2024-07-17
ft:lastPublication
2024-07-17T23:23:16.481321
The search area options set the search constraints to use when matching, such as to a city, finance area, or within a specified search radius distance that can be limited to the input state. The search area options can assist in finding a match when the input address contains limited or inaccurate city or ZIP Code information.

The following example illustrates the different match results for an input address that contains an incorrect ZIP Code when setting the Search Area to City, then to Finance Area.

Input Address Match with Search Area set to City Match with Search Area set to Finance Area

100 Main St
East Aurora, NY 14166

Input address has an incorrect ZIP Code.

100 MAIN ST
EAST AURORA NY 14052-1633

Match is made to East Aurora 14052 as there is no candidate in the 14166 input ZIP Code.

100 MAIN ST
DUNKIRK NY 14048-1844

Same finance area as the input ZIP Code 14166.

Search Area and Distance Options

Parameter Description

Option.FIND_SEARCH_AREA

Note: In CASS match mode, only the search area options described in FIND_SEARCH_AREA_DEFAULT are available.
FIND_SEARCH_AREA_DEFAULT
The impact of the FIND_SEARCH_AREA_DEFAULT setting depends on the match mode you're using for matching.
When Option.FIND_SEARCH_AREA_DEFAULT is set and you're matching using either CASS or Relaxed match mode, the search area is determined based on the Option.CentroidPreference setting:
  • If Option.CentroidPreference = AllCentroids, the FIND_SEARCH_AREA_CITY search area is used.
  • If Option.CentroidPreference is set to either NoCentroids or AddressUnavailable, the FIND_SEARCH_AREA_FINANCE search area is used.

When FIND_SEARCH_AREA_DEFAULT is set and you're matching using any other match mode - Custom, Exact, Close or Interactive - the FIND_SEARCH_AREA_FINANCE search area is used.

FIND_SEARCH_AREA_FINANCE
Searches the entire Finance Area for possible streets.
Note: This option has no effect when performing a ZIP centroid match or a geographic geocode.
FIND_SEARCH_AREA_CITY
Searches the specified city.
FIND_SEARCH_AREA_EXPANDED
Enables the setting of the search radius distance to use when matching. See Option.FIND_SEARCH_AREA_DISTANCE below.
FIND_EXPND_SRCH_LIM_TO_STATE
Limits the search to the state, within the search radius distance. The default search radius is 25 miles.

Option.FIND_SEARCH_AREA_DISTANCE

When the FIND_SEARCH_AREA_EXPANDED option is selected, this field allows you to enter the search radius distance to use when matching. Valid values = 0-99 (miles). Default = 25 miles.
Note: Ignored in CASS match mode.