Response - Spectrum_OnDemand - main

Spectrum OnDemand Web Services (REST)

Product type
Software
Portfolio
Verify
Product family
Product
Spectrum OnDemand
Version
main
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (REST)
First publish date
2006

The candidate addresses are returned one per row. If no rows are returned, then there are no matching candidates. Each row contains one or more of the elements shown in the below table, and the fields are not returned when they are empty.

Table 1. GeoTypeAheadUSCAN Output

Response Element

Description

AddressLine1

The first line of the address.

City

The city name.

Country

The country in UPU Code format.

FirmName

The firm or company name.

This field is only available for selected countries.

FormattedAddress

The formatted address in a single line that should be displayed to you as you type.

InstanceKey

Typically, it returns the InstanceKey passed as input. When the InstanceKey gets too old, a new one will be returned, and that should be passed to subsequent calls to GlobalTypeAhead.

PostalCode

The ZIP Code™ or postal code.

StateProvince

The state or province, abbreviated when postal standard requires.

Status

When it contains F, the call has failed for the specified reason. If missing, then no error occurred.

Status.Code

No known error codes are expected.

Status.Description

No known error descriptions are expected.

Locality

The locality.

ProcessedBy

Indicates which address coder processed the address.

Ranges

Additional information for each range identified for the candidate.
  • Range—The range number.
  • UnitCount—The number of units for the range.
  • UnitsInfo—Provides information for the unit and the formatted unit address.