Parameters for Options

Table 1. GetCityStateProvince Options

Parameter Name

Description

PerformUSProcessing

Specifies whether or not to process U.S. addresses. If you enable U.S. address processing GetCityStateProvince 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.
Y
Yes, process U.S. addresses (default).
N
No, do not process U.S. addresses.

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.

PerformCanadianProcessing

Specifies whether or not to process Canadian addresses. If you enable Canadian address processing GetCityStateProvince 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.
Y
Yes, process Canadian addresses (default).
N
No, do not process Canadian addresses.

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.

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).

MaximumResults

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