Parameters for Options - Spectrum_OnDemand - addressing - web_services - 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
Table 1. GetCandidateAddresses Options

Parameter

Description

Option.PerformUSProcessing

Specifies whether or not to process U.S. addresses. If you enable U.S. address processing GetCandidateAddresses will attempt to retrieve candidate addresses for U.S. addresses. If you disable U.S. address processing, U.S. addresses will fail, meaning they are returned with an "F" in the Status output field. The output field Status.Code will say "DisabledCoder." If you are not licensed for U.S. address processing you must disable U.S. address processing in order for your jobs to complete successfully, regardless of whether or not they contain U.S. addresses.

Note: You must have a valid license for U.S. address processing to successfully process U.S. addresses. If you enable U.S. address processing but are not licensed for this feature, or your license has expired, you will receive an error.
Y
Yes, process U.S. addresses (default).
N
No, do not process U.S. addresses.

Option.Database.US

Specifies the database to be used for U.S. address processing. Only databases that have been defined in the US Database Resources panel in the Management Console are available.

Option.PerformCanadianProcessing

Specifies whether or not to process Canadian addresses. If you enable Canadian address processing GetCandidateAddresses will attempt to retrieve candidate addresses for Canadian addresses. If you disable Canadian address processing, Canadian addresses will fail, meaning they are returned with an "F" in the Status output field. The output field Status.Code will say "DisabledCoder." If you are not licensed for Canadian address processing you must disable Canadian address processing in order for your jobs to complete successfully, regardless of whether or not they contain Canadian addresses.

Note: You must have a valid license for Canadian address processing to successfully process Canadian addresses. If you enable Canadian address processing but are not licensed for this feature, or your license has expired, you will receive an error.
Y
Yes, process Canadian addresses (default).
N
No, do not process Canadian addresses.

Option.Database.Canada

Specifies the database to be used for Canadian address processing. Only databases that have been defined in the Canadian Database Resources panel in the Management Console are available.

Option.PerformInternationalProcessing

Specifies whether or not to process international addresses (addresses outside the U.S. and Canada). If you enable international address processing GetCandidateAddresses will attempt to retrieve candidate addresses for international addresses. If you disable international address processing, international addresses will fail, meaning they are returned with an "F" in the Status output field. The output field Status.Code will say "DisabledCoder." If you are not licensed for international address processing you must disable international address processing in order for your jobs to complete successfully, regardless of whether or not they contain international addresses.

Note: You must have a valid license for international address processing to successfully process international addresses. If you enable international address processing but are not licensed for this feature, or your license has expired, you will receive an error.
Y
Yes, process international addresses (default).
N
No, do not process international addresses.

Option.Database.International

Specifies the database to be used for international address processing. Only databases that have been defined in the International Database Resources panel in the Management Console are available.

Option.OutputCasing

Specifies the casing of the output data. One of the following:

M
Returns the output in mixed case (default). For example:

123 Main St
Mytown FL 12345

U
Returns the output in upper case. For example:

123 MAIN ST
MYTOWN FL 12345

Option.MaximumResults

The maximum number of candidate addresses that GetCandidateAddresses should return. The default is 10. The maximum is 10.

Option.OutputShortCityName

For U.S. addresses, specifies whether or not to return the USPS®-approved abbreviation for the city, if there is one. The USPS® provides abbreviations for city names that are 14 characters long or longer. City abbreviations are 13 characters or less and can be used when there is limited space on the mailing label. If there is no short city name for the city, then the full city name is returned.

Y
Yes, return the short city name.
N
No, do not return the short city name.

Option.DualAddressLogic

(U.S. addresses only). Controls whether GetCandidateAddresses should return a street match or a PO Box/Rural Route/Highway Contract match when the address contains both street and PO Box/Rural Route/Highway Contract information. For more information, see About Dual Address Logic.

N
(Default) USPS®CASS™ regulations determine the address returned based on the following order of priority:
  1. PO Box
  2. Firm
  3. Highrise
  4. Street
  5. Rural Route
  6. General Delivery
S
Return a street match, regardless of the address line.
P
Return a PO Box match, regardless of the address line.

Option.StreetMatchingStrictness

The strictness of the street name match (U.S. addresses only).

E
The input street name must match the database exactly.
T
The matching algorithm is "tight."
M
The matching algorithm is "medium" (default).
L
The matching algorithm is "loose."

Option.FirmMatchingStrictness

The strictness of the firm name match (U.S. addresses only).

E
The input firm name must match the database exactly.
T
The matching algorithm is "tight."
M
The matching algorithm is "medium" (default).
L
The matching algorithm is "loose."

Option.DirectionalMatchingStrictness

The strictness of the directional match.

E
The input directional must match the database exactly.
T
The matching algorithm is "tight."
M
The matching algorithm is "medium" (default).
L
The matching algorithm is "loose."

Option.PerformESM

Specifies whether or not to perform Enhanced Street Matching (ESM). ESM applies extra matching logic with additional data to any input address that is not matched through the regular address validation process. ESM applies to U.S. addresses only.

Y
Yes, perform ESM processing.
N
No, do not perform ESM processing (default).

Option.AddressLineSearchOnFail

Specifies whether ValidateAddress will search address lines for the city, state/province, and postal code.

This option enables ValidateAddress to search the AddressLine input fields for the city, state/province, postal code, and country when the address cannot be matched using the values in the City, StateProvince, and PostalCode input fields.

Consider enabling this option if your input addresses have the city, state/province, and postal code information in the AddressLine fields.

Consider disabling this option if your input addresses use the City, State/Province and PostalCode fields. If you enable this option and these fields are used, there is an increased possibility that ValidateAddress will fail to correct values in these fields (for example a misspelled city name).

Y
Yes, search the address line fields (default).
N
No, do not search the AddressLine fields.