Default 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

The following table lists the options that control the format and processing of addresses. These are called "default options" because by default the apply to all addresses. Some of these options can be overridden for Canadian addresses. For more information, see Canadian Address Options.

Table 1. Default Options

Option

optionName

Parameter

Description

Canada Mailer Name Specifies the Mailer's name.
Canada Mailer Address Specifies the Mailer's address.
Canada Mailer Last line Specifies the last address line for the Mailer's address.
Canada Mailer Number Specifies the number assigned by CPC to the Mailer.

Casing

OutputCasing

Option.OutputCasing

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

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

123 Main St
Mytown FL 12345

Upper
U
Returns the output in upper case. For example:

123 MAIN ST
MYTOWN FL 12345

Insert postal code separation character

OutputPostalCodeSeparator

Option.OutputPostalCodeSeparator

Specifies whether to use separators (spaces or hyphens) in ZIP™ Codes or Canadian postal codes.

For example, a ZIP + 4® Code with the separator would be 20706-1844 and without the separator it would be 207061844. A Canadian postal code with the separator would be P5E"1S7 and without the separator it would be P5E1S7.

Y
Yes, use separator (default).
N
No, do not use separator.
Note: Spaces are used in Canadian postal codes and hyphens in U.S. ZIP + 4® Codes.

Output multinational characters

OutputMultinationalCharacters

Option.OutputMultinationalCharacters

Specifies whether or not to return multinational characters, including diacritical marks such as umlauts or accents. (Not supported for U.S. addresses).

N
No, do not use multinational characters in the output (default). Only standard ASCII characters is returned.
Y
Yes, use multinational characters in the output.
Return Country Specific Fields Returns country-specific output information. This option is required only for the SERP formatted test file and not required for regular usage.

OutputVanityCityFormatLong

Option.OutputVanityCityFormatLong

Y
Output the non-mailing city name (the vanity name) if the input city name is a non-mailing city name. For example, "Hollywood" is a non-mailing city name for "Los Angeles".
N
If you do not select this option and the input city name is a non-mailing city name, the long version of the mailing city is returned.

OutputVeriMoveDataBlock

Option.OutputVeriMoveDataBlock

Y
Returns VeriMove detail data in the output.
N
No VeriMove detail data in the output.

CanSSLVRFlg

Option.CanSSLVRFlg

Changes the civic and/or suite information to match the Large Volume Receiver (LVR) or single-single record .

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.

For more information, see Returning Multiple Matches.

Secondary address placement

StandardAddressFormat

Option.StandardAddressFormat

Specifies where to place secondary address information for U.S. addresses. Secondary address information refers to apartment numbers, suite numbers, and similar designators. For example, in this address the secondary address information is "Apt 10E" and the primary address information is "424 Washington Blvd".

Apt 10E
424 Washington Blvd
Springfield MI 49423

Same line as address
C
Place both primary and secondary address information in AddressLine1 (default).
Separate address line
S
Place the primary address information in AddressLine1 and the secondary address information in AddressLine2.
Dual address separation
D
Place both primary and secondary address information in AddressLine1 and place dropped information from dual addresses in AddressLine2. A dual address is an address that contains both street information and PO Box/Rural Route/Highway Contract information. For more information, see About Dual Address Logic.

City format

OutputShortCityName

Option.OutputShortCityName

Specifies how to format city names that have short city name or non-mailing city name alternatives. Applies to U.S. and Canadian addresses.

Short
Y
Returns 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.
Long
N
Returns the long city name (default).
Standard
S
Returns the abbreviated city name only if an abbreviated city name is used in the input address. If the input address does not use a short city name, either the long or short city name could be returned, depending on USPS® regulations for the particular city. Select this option if you are performing a CASS™ test.
Non-Mailing (Vanity)
V
Output the non-mailing city name (the vanity name) if the input city name is a non-mailing city name. For example, "Hollywood" is a non-mailing city name for "Los Angeles". If you do not select this option and the input city name is a non-mailing city name the long version of the mailing city is returned.

Country format

OutputCountryFormat

Option.OutputCountryFormat

Specifies the format to use for the country name returned in the Country output field. For example, if you select English, the country name "Deutschland" would be returned as "Germany".

English Names
E
Use English country names (default).
Spanish Names
S
Use Spanish country names.
French Names
F
Use French country names.
German Names
G
Use German country names.
ISO Codes
I
Use two-letter ISO abbreviation for the countries instead of country names.
UPU Codes
U
Use Universal Postal Union abbreviation for the countries instead of country names.

PBKey

Option.PBKey

This controls whether PBKey is returned with addressing results. The PBKey is useful:
  • To determine whether the address exists, even though USPS says it isn't a deliverable address. It also helps to determine whether something can be shipped when it can be mailed.
  • With other Precisely offerings that use PBKey as input.

Default country

HomeCountry

Option.HomeCountry

Specifies the default country. You should specify the country where most of your addresses reside. For example, if most of the addresses you process are in Canada, specify Canada. Validate MailingAddressUSCAN uses the country you specify to attempt validation when it cannot determine the country from the StateProvince, PostalCode, and Country address fields. The valid country names are:

Afghanistan, Albania, Algeria, American Somoa, Andorra, Angola, Anguilla, Antigua And Barbuda, Argentina, Armenia, Aruba, Australia, Austria, Azerbaijan, Bahamas, Bahrain, Bangladesh, Barbados, Belarus, Belgium, Belize, Benin, Bermuda, Bhutan, Bolivia, Bosnia And Herzegovina, Botswana, Brazil, British Virgin Islands, Brunei Darussalam, Bulgaria, Burkina Faso, Burundi, Cambodia, Cameroon, Canada, Cape Verde, Cayman Islands, Central African Republic, Chad, Chile, China, Colombia, Comoros Islands, Congo, Cook Islands, Costa Rica, Cote D'Ivoire, Croatia, Cuba, Cyprus, Czech Republic, Democratic Republic Of Congo, Denmark, Djibouti, Dominica, Dominican Republic, East Timor, Ecuador, Egypt, El Salvador, Equitorial Guinea, Eritrea, Estonia, Ethiopia, Falkland Islands, Faroe Islands, Federated States Of Micronesia, Fiji, Finland, France, French Guiana, Gabon, Gambia, Germany, Ghana, Gibraltar, Greece, Greenland, Grenada, Guadeloupe, Guam, Guatemala, Guinea, Guinea Bissau, Guyana, Haiti, Holy See, Honduras, Hong Kong, Hungary, Iceland, India, Indonesia, Iran, Iraq, Ireland, Israel, Italy, Jamaica, Japan, Jordan, Kazakhstan, Kenya, Kiribati, Korea, Kuwait, Kyrgyzstan, Laos, Latvia, Lebanon, Lesotho, Liberia, Libya, Liechtenstein, Lithuania, Luxembourg, Macau, Macedonia, Madagascar, Malawi, Malaysia, Maldives, Mali, Malta, Marshall Islands, Martinique, Mauritania, Mauritius, Mayotte, Mexico, Moldova, Monaco, Mongolia, Monserrat, Morocco, Mozambique, Myanmar, Namibia, Nauru, Nepal, Netherlands Antilles, New Caledonia, New Zealand, Nicaragua, Niger, Nigeria, Niue, Norway, Oman, Pakistan, Palau, Panama, Papua New Guinea, Paraguay, Peru, Philippines, Pitcairn Islands, Poland, Portugal, Puerto Rico, Qatar, Republic Of Georgia, Republic Of Korea, Republic Of Singapore, Reunion, Romania, Russia, Rwanda, Saint Helena, Saint Kitts And Nevis, Saint Lucia, Saint Pierre And Miquelon, Saint Vincent and the Grenadines, Samoa, San Marino, Sao Tome and Principe, Saudi Arabia, Senegal, Seychelles, Sierra Leone, Slovakia, Slovenia, Solomon Islands, Somalia, South Africa, Spain, Sri Lanka, Sudan, Surivalue, Swaziland, Sweden, Switzerland, Syria, Tahiti, Taiwan, Tajikistan, Tanzania, Thailand, The Netherlands, Togo, Tonga, Trinidad And Tobago, Tristan Da Cunha, Tunisia, Turkey, Turkmenistan, Turks And Caicos Islands, Tuvalu, Uganda, Ukraine, United Arab Emirates, United Kingdom, United States, Uruguay, Uzbekistan, Vanuatu, Venezuela, Vietnam, Virgin Islands (US), Wallis And Futuna, Yemen, Yugoslavia, Zambia, Zimbabwe

Dual address logic

DualAddressLogic

Option.DualAddressLogic

Indicates how to return a match if multiple non-blank address lines are present or multiple address types are on the same address line. (U.S. addresses only.)

Normal Match
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
Street Match
S
Return a street match, regardless of the address line.
PO Box Match
P
Return a PO Box match, regardless of the address line.

For more information, see About Dual Address Logic.