InputParameters for Input Data - 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

Validate MailingAddressUSCAN takes an address as input. All addresses use this format regardless of the address's country. See Address Line Processing for U.S. Addresses for important information about how address line data is processed for U.S. and Canada addresses.

Table 1. Input Format

Field Name

columnName

Parameter

Format

Description

AddressLine1

Data.AddressLine1

String [50]

The first address line.

AddressLine2

Data.AddressLine2

String [50]

The second address line.

AddressLine3

Data.AddressLine3

String [50]

The third address line.

Does not apply to Canadian addresses.

AddressLine4

Data.AddressLine4

String [50]

The fourth address line.

Does not apply to Canadian addresses.

AddressLine5

Data.AddressLine5

String [50]

The fifth address line.

Applies only to U.K. addresses. May contain street name, unit number, building number, and so on.

City

Data.City

String [50]

The city name.

For U.S. and Canada addresses only, you may put the city, state, and ZIP Code™ in the City field. If you do this, you must leave the StateProvince and PostalCode fields blank.

StateProvince

Data.StateProvince

String [50]

The state or province.

For U.S. and Canada addresses only, you may put the state in the City field instead of the StateProvince field.

PostalCode

Data.PostalCode

String [10]

The postal code for the address in one of the following formats:

99999
99999-9999
A9A9A9
A9A 9A9
9999 999

For U.S. and Canada addresses only, you may put the ZIP Code™ in the City field.

For U.S. and Canada addresses only, if the city/state/ZIP Code™ is in the PostalCode field, Validate MailingAddressUSCAN may parse the data and successfully process the address. For best results, put this data in the appropriate fields (City, StateProvince, and PostalCode).

Country

Data.Country

String [50]

The country code or name, in any of the following formats:

  • Two-character ISO 3166-1 Alpha 2 country code
  • Three-character ISO 3166-1 Alpha 3 country code
  • English country name
  • French country name
  • German country name
  • Spanish country name

For a list of ISO codes, see ISO Country Codes and Module Support.

The ISO codes are as follows:
  • For Canada, the ISO 3166-1 Alpha-2 code is CA, and ISO 3166-1 Alpha-3 code is CAN.
  • For US, the ISO 3166-1 Alpha-2 code is US, and ISO 3166-1 Alpha-3 code is USA.

FirmName

Data.FirmName

String [50]

The company or firm name.

USUrbanName

Data.USUrbanName

String [50]

The U.S. address urbanization name. This is used primarily for Puerto Rico addresses.

CustomerID

Data.CustomerID

String [9]

If this mailpiece uses a generic barcode, specify your USPS®-assigned customer ID in this field. The Validate AddressUSCAN generic barcode is used for mailpieces that use the OneCode ACS® service.

CanLanguage

Data.CanLanguage

String

For Canadian addresses only, indicates whether the address is in English or French, if the option CanFrenchFormat=T is used.

For Canadian addresses only, indicates whether the address is in English or French, if the option Option.CanFrenchFormat=T is used.

For Canadian addresses only, indicates whether the address is in English or French, if the option the Determine language using field on the Canadian Address Options tab is set to CanLanguage input field.

If this field is blank, the address is formatted in English. If the field contains any non-blank value, the address is formatted in French. Note that addresses in Quebec are always formatted in French regardless of the value in this field.

InstanceKey

Data.InstanceKey

String

The key used with GlobalTypeAhead services.