Parsed Input - 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 output can include the input address in parsed form. This type of output is referred to as "parsed input." Parsed input fields contain the address data that was used as input regardless of whether or not ValidateMailingAddressUSCAN validated the address. Parsed input is different from the "parsed address elements" output in that parsed address elements contain the validated address if the address could be validated, and, optionally, the input address if the address could not be validated. Parsed input always contains the input address regardless of whether or not ValidateMailingAddressUSCAN validated the address.

To include parsed input fields in the output, set Option.OutputRecordType=I.

Table 1. Parsed Input

Response Element

Description

ApartmentLabel.Input

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

ApartmentNumber.Input

Apartment number, for example: 123 E Main St APT 3

CanadianDeliveryInstallationAreaName.Input

Delivery installation name (Canadian addresses only)

CanadianDeliveryInstallationQualifierName.Input

Delivery installation qualifier (Canadian addresses only)

CanadianDeliveryInstallationType.Input

Delivery installation type (Canadian addresses only)

City.Input

Validated city name

Country.Input

Country. Format is determined by what you selected in Data.OutputCountryFormat:

  • ISO Code
  • UPU Code
  • English
  • French
  • German
  • Spanish

FirmName.Input

The validated firm or company name

HouseNumber.Input

House number, for example: 123 E Main St Apt 3

LeadingDirectional.Input

Leading directional, for example: 123 E Main St Apt 3

POBox.Input

Post office box number. If the address is a rural route address, the rural route box number will appear here.

PostalCode.Input

Validated postal code. For U.S. addresses, this is the ZIP Code.

PrivateMailbox.Input

Private mailbox indicator

PrivateMailbox.Type.Input

The type of private mailbox. Possible values include:

  • Standard
  • Non-Standard

RRHC.Input

Rural Route/Highway Contract indicator

StateProvince.Input

Validated state or province name

StreetName.Input

Street name, for example: 123 E Main St Apt 3

StreetSuffix.Input

Street suffix, for example: 123 E Main St Apt 3

TrailingDirectional.Input

Trailing directional, for example: 123 Pennsylvania Ave NW

USUrbanName.Input

USPSĀ® urbanization name