Parameters for Options - Spectrum_OnDemand - Latest

Spectrum OnDemand Web Services (REST)

Product type
Software
Portfolio
Verify
Product family
Spectrum
Product
Spectrum > Discovery
Spectrum > Web Services
Spectrum > Spatial > Spectrum Spatial Insights
Spectrum > Dataflow Designer
Spectrum > Geo Addressing > Enterprise Tax
Spectrum > Spatial > Spectrum Spatial Analyst
Spectrum OnDemand
Spectrum > Quality > Context Graph
Spectrum > Spectrum Platform
Spectrum > Quality > Addressing
Spectrum > Spatial > Spectrum Spatial
Spectrum > Quality > Spectrum Quality
Version
Latest
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (REST)
Copyright
2024
First publish date
2006
Last updated
2024-08-28
Published on
2024-08-28T12:55:51.727818

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

Table 1. GeoTypeAheadOption

Parameter

Description

Option.Layout

H
Returns hierarchical data.
F
Returns Flat data.

Default: 'H'

Option.MaximumCandidates

Specifies the maximum number of candidates to return.

It may be between 1 and 20.

If customer exceeds 20, the MaximumCandidates value will be set to 20 only.

Default: '10'

Option.OutputCasing

Specifies the casing of the output data. The possible values are:

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

123 Main St

Mytown FL 12345

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

123 MAIN ST

MYTOWN FL 12345

Note: The default is M (Mixed).

Option.SearchOnAddressNumber

Specifies if Address Number matching the input number are returned or not. Currently when you input just a number in the MainAddressLine, responses with street names that match the input number are returned. For example:

An input of 350 could return the following response:

  • 225 S 350 E, # 350E, PIMA, AZ 85543
  • 1244 W 350 N, PIMA, AZ 85543
  • 112 E 350 N, BLACKFOOT, ID 83221

Once you set searchOnAddressNumber=Y, the same input would return these response:

  • 350 EDNA RD, HOOVER, AL 35244
  • 350 OAK LEAF CIR, HOOVER, AL 35244
  • 350 SUMMIT PL, BIRMINGHAM, AL 35243

Possible Values: 'Y' or 'N'.

Default: 'Y'