Parsed Address Elements Output - Spectrum_OnDemand - addressing - web_services

Parsed Address Elements Output - 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

Output addresses are formatted in the parsed address format if you set OutputRecordType=E. If you want formatted data in the Parsed Address format to be returned when validation fails (that is, a normalized address), specify OutputFormattedOnFail=Y.

Output addresses are formatted in the parsed address format if you set Option.OutputRecordType=E. If you want formatted data in the Parsed Address format to be returned when validation fails (that is, a normalized address), specify Option.OutputFormattedOnFail=Y.

Output addresses are formatted in the parsed address format if you select the Include matched address elements check box. If you want Validate Address to return formatted data in the Parsed Address format when validation fails (that is, a normalized address), select the Return normalized data when no match is found check box.

Note: If you always want parsed input data returned regardless of whether or not validation is successful, specify OutputRecordType=I. If you always want parsed input data returned regardless of whether or not validation is successful, specify Option.OutputRecordType=I. If you always want return parsed input data returned regardless of whether or not validation is successful, select Include standardized input address elements. For more information, see Parsed Input.

Table 1. Parsed Address Output
Field Name columnName Response Element	Description
AdditionalInputData	Input data not used by Validate MailingAddressUSCAN. For more information, see Additional Input Data.
AdditionalInputData.Base	Input data that was not output to the standardized address by Validate MailingAddressUSCAN. For more information, see Additional Input Data.
AdditionalInputData.Unmatched	Input data passed to the matcher but not used by Validate MailingAddressUSCAN for validation. For more information, see Additional Input Data.
ApartmentLabel	Apartment designator (such as STE or APT), for example: 123 E Main St APT 3
ApartmentLabel2	Secondary apartment designator, for example: 123 E Main St APT 3, 4th Floor Note: In this release, this field will always be blank.
ApartmentNumber	Apartment number. For example: 123 E Main St APT 3
ApartmentNumber2	Secondary apartment number. For example: 123 E Main St APT 3, 4th Floor Note: In this release, this field will always be blank.
CanadianDeliveryInstallationAreaName	Delivery installation name (Canadian addresses only)
CanadianDeliveryInstallationQualifierName	Delivery installation qualifier (Canadian addresses only)
CanadianDeliveryInstallationType	Delivery installation type (Canadian addresses only)
City	Validated city name
Country	Country. Format is determined by what you selected in Country formatOutputCountryFormatData.OutputCountryFormat: ISO Code UPU Code English French German Spanish
DepartmentName	For U.K. addresses only, a subdivision of a firm. For example, Engineering Department. [Since the field is currently UK only this does not apply] A subdivision of a country used in French and Spanish speaking countries. For example, France is divided into 100 departments.
FirmName	The validated firm or company name
HouseNumber	House number, for example: 123 E Main St Apt 3
LeadingDirectional	Leading directional, for example: 123 E Main St Apt 3
POBox	Post office box number. If the address is a rural route address, the rural route box number will appear here.
PostalCode	Validated postal code. For U.S. addresses, this is the ZIP Code.
PrivateMailbox	Private mailbox indicator.
PrivateMailbox.Type	The type of private mailbox. Possible values include: Standard Non-Standard Note: This replaces PrivateMailboxType (no period in field name). Please modify your API calls accordingly.
RRHC	Rural Route/Highway Contract indicator
StateProvince	Validated state or province name
StreetName	Street name, for example: 123 E Main St Apt 3
StreetSuffix	Street suffix, for example: 123 E Main St Apt 3
TrailingDirectional	Trailing directional, for example: 123 Pennsylvania Ave NW
USUrbanName	USPS® urbanization name. Puerto Rican addresses only.