Returning Multiple Matches - Spectrum_OnDemand - addressing - web_services - 23.1

Spectrum Web Services Guide

Product type
Software
Portfolio
Integrate
Product family
Spectrum
Product
Spectrum > Web Services
Version
23.1
Language
English
Product name
Spectrum Technology Platform
Title
Spectrum Web Services Guide
First publish date
2007
Last updated
2024-10-17
Published on
2024-10-17T00:33:46.811413

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

Option Name

optionName

Parameter

Description

Return multiple addresses

KeepMultimatch

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.

Maximum results

MaximumResults

Option.MaximumResults

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

Next to the Return multiple addresses check box, enter 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.
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.
Note: The difference between unchecking Return multiple addresses and checking Return multiple addresses and specifying a maximum number of results of 1 is that a multiple match will return a failure if Return multiple addresses is unchecked, whereas a multiple match will return one record if Return multiple addresses is checked and the maximum number of results is 1.

Include result codes for individual fields

OutputFieldLevelReturnCodes

Option.OutputFieldLevelReturnCodes

To identify which output addresses are candidate addresses, you must specify a value of Y for OutputFieldLevelReturnCodes. To identify which output addresses are candidate addresses, you must specify a value of Y for Option.OutputFieldLevelReturnCodes. To identify which output addresses are candidate addresses, you must check Include result codes for individual fields on the Output Data tab. 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.