Output

Global Type Ahead output is determined by the output options you selected.

Returned candidates can be previewed in the Management Console. Candidates include the complete address elements that you expect to see in Spectrum Technology Platform candidates, such as AddressLine, Range, City, County, State, and Country.
Note: The Global Type Ahead stage currently supports Range and Range Units for the United Kingdom (GBR) and the United States (USA). For the United Kingdom (GBR), UK Royal Mail (RM) data is used. For the United States (USA), Master Location Data (MLD) is used.
Table 1. Global Type Ahead Output
Field Name Format Description
AddressLine1 String The complete first line of the address, typically including street and house number.
AddressNumber.Match String The status of the match attempt on address number. Returns true to indicate that the input address number matched the candidate. If address number is not matched, this field is not returned.
City String The city or town name.
City.Match String The status of the match attempt on city. Returns true to indicate that the input city matched the candidate. If city is not matched, this field is not returned.
County String The county name.
Country String The country name.
FirmName String The name of a company.
FormattedAddress String The formatted address.
LastLine String The last line of the address. For example, 10 DOWNING STREET LONDON, SW1A 2AA.
Locality String The locality.
PostalCode String The postal code for the address. The format of the postal code varies by country.
RangeCount String The number of ranges for the candidate.
Ranges String 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.
StateProvince String The name of one of the state or province depending on the country.
StreetName.Match String The status of the match attempt on street name. Returns true to indicate that the input street name matched the candidate. If street name is not matched, this field is not returned.
Type String Returns 1 for a POI match. Returns 2 for a street address match. POI and category/subcategory features are available only if you have licensed and installed POI data. You must have a license for POI data to include it and be able to return candidates for the dictionary.