Returning Multiple Matches - 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

If ValidateAddress finds multiple address in the postal database that are possible matches for the input address, you can have ValidateAddress return the possible matches. For example, the following address matches multiple addresses in the U.S. postal database:

PO BOX 1
New York, NY

Options

To return multiple matches, use the options described in the following table.

Table 1. Multiple Match Option

Parameter

Description

Option.KeepMultimatch

Indicates whether or not to return multiple address for those input addresses that have more than one possible match.

Y
Yes, return multiple matches (default).
N
No, do not return multiple matches.

Option.MaximumResults

A number between 1 and 10 that indicates the maximum number of addresses to return.

The default value is 1.

Note: The difference between Option.Keepmultimatch=N and Option.KeepMultimatch=Y/Option.MaximumResults=1 is that a multiple match will return a failure if Option.KeepMultimatch=N, whereas a multiple match will return one record if Option.KeepMultimatch=Y and Option.MaximumResults=1.

Option.OutputFieldLevelReturnCodes

To identify which output addresses are candidate addresses, you must specify a value of Y for Option.OutputFieldLevelReturnCodes. When you do this, records that are candidate addresses will have one or more "M" values in the field-level result indicators.

Output

When you choose to return multiple matches, the addresses are returned in the address format you specify. For information on specifying address format, see Output Data Options. To identify which records are the candidate addresses, look for multiple "M" values in the field-level result indicators. For more information, see Field-Level Result Indicators.