Parameters for Options - Spectrum_OnDemand - 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

The following table lists the options that control the type of information returned by ValidateMailingAddress.

Table 1. ValidateMailingAddress Option

Parameter

Description

Option.IncludeCountryInAddressBlock

Indicates whether the country should appear at the end of the Address Block.

For international mailing, the country needs to be a part of the address block. For domestic mailing, it is superfluous.

Y

Yes, include the UPU country name in the address block (default).

N
No, do not include the UPU country name in the address block.

Option.OutputCasing

Specifies the casing of the output data. The possible values are:

M (Mixed)
The output in mixed case (default). For example,

123 Main St

Mytown FL 12345

U (Upper)
The output in upper case. For example,

123 MAIN ST

MYTOWN FL 12345

Note: The default is M (Mixed).

Option.OutputAddressBlocks

Specifies whether to return a formatted version of the address as it would be printed on a physical mailpiece. Each line of the address is returned in a separate address block field. There can be up to nine address block output fields: AddressBlock1 through AddressBlock9.

For example, this input address:

AddressLine1: 4200 Parliament Place
AddressLine2: Suite 600
City: Lanham
StateProvince: MD
PostalCode: 20706

Results in this address block output:

AddressBlock1: 4200 PARLIAMENT PL STE 600
AddressBlock2: LANHAM MD 20706-1882
AddressBlock3: UNITED STATES OF AMERICA

ValidateMailingAddress formats the address into address blocks using postal authority standards. The country name is returned using the Universal Postal Union country name. Note that the option Option.CountryFormat does not affect the country name in the address block, it only affects the name returned in the Country output field.

For addresses outside the U.S. and Canada, if ValidateMailingAddress is unable to validate the address, no address blocks are returned. For addresses in the U.S. and Canada, address blocks are returned even if validation fails.

Y
Yes, return address blocks.
N
No, do not return address blocks. Default.