Parameters for Options - 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

GlobalTypeAhead USA takes an address fragment as input, for example, '123 Mai', '123 Main St, Apple', and returns candidate addresses that match the input.

Table 1. GlobalTypeAhead USA Option

Parameter

Description

Option.Layout

H
Returns hierarchical data.
F
Returns Flat data.

Option.MaximumCandidates

Specifies the maximum number of candidates to return.

It may be between 1 and 99.

Option.OutputCasing

Specifies the casing of the output data. The possible valuesare:

M (Mixed)
The output in mixed case (default). For example,

123Main St

Mytown FL 12345

U (Upper)
The output in upper case. For example,

123 MAINST

MYTOWN FL 12345

Note: The default is M (Mixed).

Option.SearchOnAddressNumber

Specifies whether to match the Address Number with the input number. The possible values are:

Y
It includes search based on the Address Number.
N
It does not include search based on the Address Number.
Note: The default is N (No).

Option.Separator

Specifies whether to use separators (spaces or hyphens) in ZIP™Codes or Canadian postal codes.

For example, a ZIP + 4® Code with the separator would be20706-1844, and without the separator, it would be 207061844. ACanadian postal code with the separator would be P5E"1S7, andwithout the separator, it would be P5E1S7.
Note: Spaces are used in Canadian postal codes and hyphens in U.S. ZIP + 4® Codes.

Option.UnitFirst

Specifies whether the unit number should appear at the start orthe end of the formatted/AddressLine1.

N
The unit number appears at the end of AddressLine1.

For example, the unit number, such as Unit 17, inthe output, moves to the end of AddressLine1 asbelow.

AddressLine: 50 Water Street, Lee,MA, 01238, would appearas

AddressLine: 50 Water Street, Unit 17,Lee, MA, 01238

because it considers theAddressLine1 as 'Unit Number + 50 WaterStreet'.

Y
The unit number appears at the start ofAddressLine1.
For example, the unit number, such as Unit 17, in theoutput, moves to the start of AddressLine1 asbelow.

AddressLine: 50 Water Street, Lee, MA,01238, would appear as

AddressLine:Unit 17, 50 Water Street, Lee, MA,01238