Matching Options - Spectrum_OnDemand - Latest

Spectrum OnDemand Web Services (REST)

Product type
Software
Portfolio
Verify
Product family
Spectrum
Product
Spectrum OnDemand
Spectrum > Spatial > Spectrum Spatial Analyst
Spectrum > Geocoding > Enterprise Tax
Spectrum > Spatial > Spectrum Spatial
Enterprise Geocoding
Spectrum > Dataflow Designer
Spectrum > Discovery
Spectrum > Quality > Addressing
Spectrum > Web Services
Spectrum > Spectrum Platform
Spectrum > Quality > Context Graph
Spectrum > Quality > Spectrum Quality
Spectrum > Spatial > Spectrum Spatial Insights
Version
Latest
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (REST)
Copyright
2024
First publish date
2006
ft:lastEdition
2024-06-03
ft:lastPublication
2024-06-03T16:02:19.077100

Matching options are used to determine how address searches are performed. They let you set match preferences, criteria and restrictions, and multiple match settings so that the matching can be as strict or relaxed as you need.

Parameter Description

Option.MatchMode

Specifies how to determine whether a candidate is a close match. One of these:

CustomMode
This option allows you to specify which parts of a candidate address must match the input address to be considered a close match. Use the MustMatch<Element> options to specify the address elements you want. This is the default value for most countries.
ExactMode
All of the candidate address's elements must match in order for the candidate to be considered a close match.
CloseMode
Only the candidate address's house number must match in order for the candidate to be considered a close match. For Chile, China, Great Britain, Estonia, India, Indonesia, Latvia, Lithuania, Slovakia, Slovenia, Taiwan, and South Africa, only the street name and town must match.
RelaxedMode
All candidate addresses are considered a close match.

Option.MustMatchInput

Specifies whether candidates must match all non-blank input fields to be considered a close match. For example, if an input address contains a city and postal code, then candidates for this address must match the city and postal code to be considered a close match.

Y
Yes, a candidate must match all input to be considered a close match.
N
No, a candidate does not have to match all input to be considered a close match. Default.

Option.MustMatchCity

Specifies whether candidates must match the city. If you do not require exact matches on city, the geocoder searches on the street address matched to the particular postal code, and considers other cities that do not match the name, but do match the postal code.

Y
Yes, candidates must match the city. Default.
N
No, candidates do not have to match the city.

Option.MustMatchHouseNumber

Specifies whether candidates must match the house number. If the input house number is not within a range from the street, GeocodeAddressCAN selects the nearest range on the street which has the same parity (even or odd house number) as the input address number. GeocodeAddressCAN returns one or more of the closest matches inside this range that preserves street parity. This requires GeocodeAddressCAN to change the house number. The new house number is equal to one of the range's endpoints, possibly plus or minus one to preserve street parity.

Note: Even when this option is disabled and an inexact match on the house number is found, GeocodeAddressCAN still returns an error code.

When this option is disabled and no exact matching house number is found, a match code of either E029 (no matching range, single street segment found), or E030 (no matching range, multiple street segment) is returned.

GeocodeAddressCAN does not change the house number on the output address. In order to access the inexact address number candidates, you must specify Option.KeepMultimatch=Y. If there are inexact house number candidates returned, the corresponding match codes begin with the letter 'H' indicating that the house number was not matched.

Additionally, even when one or more exact candidates are found, inexact matches to the house number are still on the list of possible candidates, and these can be differentiated from the others by their Hxx match codes. For more information about match codes, see Match Codes..

One of these:

Y
Yes, candidates must match the house number. Default.
N
No, candidates do not have to match the house number.

Option.MustMatchPostalCode

Specifies whether candidates must match the postal code. If you do not require exact match on postal codes, the geocoder searches a wider area for a match. While this results in slower performance, the match rate is higher because the request does not need to match exactly when it compares match candidates.

Y
Yes, candidates must match the postal code.
N
No, candidates do not have to match the postal code. Default.

Option.MustHaveFullPostalCode

Require full postal code for the close match.

Legal Values: Y = Yes, N = No

Default Values: N = No

Option.MustMatchStateProvince

Specifies whether candidates must match the state.

Y
Yes, candidates must match the state. Default.
N
No, candidates do not have to match the state.

Option.MustMatchStreet

Specifies whether candidates must match the street name.

Y
Yes, candidates must match the street name. Default.
N
No, candidates do not have to match the street name.

Option.MustMatchLocality

Specifies whether candidates must match the locality (or equivalent) to be considered a close match.

Y
Yes, candidates must match the street name.
N
No, candidates do not have to match the street name. Default.

If you do not require exact matches on locality, the geocoder searches on the street address matched to the particular postal code, and considers other localities that do not match the name, but do match the postal code.