Returned Candidate Fields
Additional Returned Fields
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, City, County, State, and Country. It can also return matched fields, indicating the input fields that were matched in the returned suggested candidates.
GeoComplete Additional Returned Fields
Field Name | Description |
---|---|
AddressLine1 | Complete first line of address, typically including street and house number. |
AddressNumberMatch | Returns true to indicate that the input address number matched the candidate. If address number is not matched, this field is not returned. |
AreaName1Match | Returns true to indicate that the input cstate or province matched the candidate. If it is not matched, this field is not returned. |
AreaName2Match | Returns true to indicate that the input county, region or district matched the candidate. If it is not matched, this field is not returned. |
AreaName3Match | Returns true to indicate that the input city or town matched the candidate. If it is not matched, this field is not returned. |
AreaName4Match | Returns true to indicate that the input locality matched the candidate. If it is not matched, this field is not returned. |
City | City or town name. |
County | County, region or district |
Country | Country 3-letter ISO code. |
Distance | Distance from origin in kilometers or miles. A distance of -0.0 means that an origin was not used. |
DistanceUnit | Distance unit (kilometers or miles) |
featureID | unique FeatureID |
FormattedString | Formatted address string |
isUserDictionary | True if candidate comes from a user dictionary, false if not from user dictionary. |
Latitude | Latitude coordinate of candidate. For POI candidates, these are exact coordinates. For street candidates, these coordinates are approximate. To get a more exact coordinates, you must perform a geocode operation on the street candidate. |
Longitude | Longitude coordinates of candidate. Coordinates are exact or approximate, as described for Latitude field. |
Locality | Name of the locality, suburb or village |
miCode | For POI candidates, this miCode is an eight-digit numeric code that identifies POI features by category, subcategory, and subfeature. This is not the same as the featureID and is not related to the Category and Subcategory fields described above. See miCodes for a comprehensive listing of miCodes that are used for all countries. |
Name | Name of the point of interest. |
PlaceNameMatch | Returns true to indicate that the input place name matched the candidate. If place name is not matched, this field is not returned. |
PostalCode | Postal code |
StateProvince | State or province name |
StreetName | Street name |
StreetNameMatch | Returns true to indicate that the input street name matched the candidate. If street name is not matched, this field is not returned. |
Type | Returns 1 for a POI match. Returns 2 for a street address match. |