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 ValidateMailingAddressPro validated the address.

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

Table 1. Parsed Input

Parameter

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

City.Input

City name

Country.Input

Country. Format is determined by what you selected in:

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

FirmName.Input

The input 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

RRHC.Input

Rural Route/Highway Contract indicator

StateProvince.Input

State or province name

Principality.Input*

The largest geographic data element within a country.

Subcity.Input*

A smaller population center data element, dependent on the contents of the Locality field. For instance, Turkish Neighbourhood.

County.Input*

The smallest geographic data element within a country, for instance, USA County.

SubStreet.Input*

The dependent street or block data element within a country. For instance, UK Dependent Street.

StreetAlias.Input

Alternate street name; typically applies only to a specific range of addresses on the street. If you do not allow street aliases in the output then the street's "base" name will appear in the output regardless of whether or not there is an alias for the street. The base name is the name that applies to the entire street. For example, if StreetName is "N MAIN ST" the StreetAlias field would contain "MAIN" and the thoroughfare type,"ST", would be returned in the StreetSuffix field.

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

*This is a subfield and may not contain data.