Parameters for Options

GlobalTypeAhead 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 International Option

Parameter

Description

Layout

H
Returns hierarchical data.
F
Returns Flat data.

MaximumCandidates

Specifies the maximum number of candidates to return.

It may be between 1 and 99.
Note: For France (FRA), Italy (ITA), South Korea (KOR), and Germany (DEU), the maximum number of candidates returned is 20.

OutputScript

Specifies the alphabet or script in which the output should be returned. This option is bi-directional and generally takes place from Native to Latin and Latin to Native.

InputScript
Do not perform transliteration and provide output in the same script as the input.
Latn
Output in the native script for the selected country wherever possible.
Native
Use English values.
Note: The default is InputScript.

OutputCasing

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

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).

OutputAddressElements

Y
Parsed output address elements are returned.
N
No parsed output address elements are returned.