Parameters for Options

The GlobalTypeAheadUSAPremium APIs with this add-onfeature:
  • Support for rural route (RR), highway contract (HC), or P.O. boxaddress.

An address can be a street address, a rural route address, a highway contract address, a P.O. box address, a private mailbox address or a Military Post Boxes.

Table 1. GlobalTypeAhead USAPremium 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.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