OptionsParameters for Options - 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
Table 1. Get City State Province Options

Option Name

optionName

Parameter Name

Description

Enable U.S. address processing

PerformUSProcessing

Option.PerformUSProcessing

Specifies whether or not to process U.S. addresses. If you enable U.S. address processing Get City State Province will attempt to return the state 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. 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.

Database

Database.US

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.

Enable Canadian address processing

PerformCanadianProcessing

Option.PerformCanadianProcessing

Specifies whether or not to process Canadian addresses. If you enable Canadian address processing Get City State Province will attempt to return the province 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. 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.

Database

Database.Canada

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.

Include non-mailing city

OutputVanityCity

Option.OutputVanityCity

Specifies whether or not to include non-mailing city names in the output. A non-mailing city name is an alternate name for the primary city name. For example, Hollywood is a non-mailing city name for Los Angeles.

Y
Yes, include non-mailing city names.
N
No, do not include non-mailing city names (default).

Maximum records to return

MaximumResults

Option.MaximumResults

Specifies the maximum number of city-state/province pairs to return. The default value is 10.