Returning Multiple Matches - Spectrum_OnDemand - main

Spectrum OnDemand Web Services (SOAP)

Product type
Software
Portfolio
Verify
Product family
Product
Spectrum OnDemand
Version
main
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (SOAP)
First publish date
2006

If ValidateMailingAddressUSCAN finds multiple address in the postal database that are possible matches for the input address, you can have ValidateMailingAddressUSCAN 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

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.

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 Keepmultimatch=N and KeepMultimatch=Y/MaximumResults=1 is that a multiple match will return a failure if KeepMultimatch=N, whereas a multiple match will return one record if KeepMultimatch=Y and MaximumResults=1.

OutputFieldLevelReturnCodes

To identify which output addresses are candidate addresses, you must specify a value of Y for 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.