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

Output addresses are formatted in the parsed address format if you set Option.OutputRecordType=E.

Table 1. Parsed Address Output

Parameter

Description

AdditionalInputData

Input data not used by address validation engine. For more information, see Additional Input Data.

ApartmentLabel

Apartment designator (such as STE or APT), for example: 123 E Main St APT 3

ApartmentLabel2

The type of unit, such as apartment, suite, or lot, for addresses that contain two units, such as: 123 E Main St APT 3, 4th Floor.

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.

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.

PrivateMailbox

Private mailbox indicator.

PrivateMailbox.Type

The type of private mailbox. Possible values include:

  • Standard
  • Non-Standard

StreetName.Alias.Type

This result code applies to U.S. addresses only.

Note: In previous releases this field was named StreetName.AliasType with no "." between "Alias" and "Type." This old name is obsolete. Please update your processes to use the new name StreetName.Alias.Type.
Abbreviated
The alias is an abbreviation of the street name. For example, HARTS-NM RD is an abbreviated alias for HARTSVILLE NEW MARLBORO RD.
Changed
There has been an official street name change and the alias reflects the new name. For example if SHINGLE BROOK RD is changed to CANNING DR, then CANNING DR would be a changed alias type.
Other
The street alias is made up of other names for the street or common abbreviations of the street.
Preferred
The street alias is the locally preferred alias. For example, a street is named "South Shore Dr." because it runs along the southern shore of a lake, not because it is south of a municipal demarcation line. So, "South" is not a predirectional in this case and should not be shorted to "S". So, "South Shore Dr." would be the preferred alias.

PostalCode.Type

P
The ZIP Code™ contains only PO Box addresses. U.S. addresses only.
U
The ZIP Code™ is a unique ZIP Code™ assigned to a specific company or location. U.S. addresses only.
M
The ZIP Code™ is for military addresses. U.S. addresses only.
null
The ZIP Code™ is a standard ZIP Code™.

RRHC

Rural Route/Highway Contract indicator

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