Geocoding on the locations resource allows you to retrieve longitude and latitude coordinates as well as address information for a given address. If the geocoding service finds multiple results that match the address object, by default, the best match is returned. To receive multiple results set the optional list property to the desired amount.
The response from the geocode method is an JSON formatted array of GeocodeOutputLocation objects that contains the longitude and latitude coordinates for the address as well as other address information if the address could be geocoded.
| Data Element | Description | Data Type | Value/Example |
|---|---|---|---|
Address |
Encapsulates the details about the location. | Complex | |
Coords |
Encapsulates the details about the longitude/latitude. | Complex | |
Region |
Indicates the region of the location. | Enum |
0 - Unknown 1 - AF 2 - AS 3 - EU 4 - NA(default) 5 - OC 6 - SA 7 - ME |
Label |
The label to be displayed on maps and reports in association with a stop. | String | |
PlaceName |
The place name which corresponds to custom place. | String | |
Errors |
Encapsulated the details about the errors associated with the geocode location. | List of Complex Objects | |
ConfidenceLevel |
The confidence level of the match. See detailed definition in Glossary. | String | Exact, Good, Uncertain, Failed |
DistanceFromRoad |
The distance from coordinate to nearest road. | Double | |
TimeZone |
Time zone that the geocoded result is situated within. | String | |
SpeedLimitInfo |
Speed limit of the geocoded coordinates. | Complex | |
SpeedLimitHeading |
Heading used for reverse geocoding to properly snap to the right link. | Double |
| Data Element | Description | Data Type | Value/Example |
|---|---|---|---|
StreetAddress |
The house number and street name. | string | 1 Independence Way |
City |
The name of the city. | string | Princeton |
State |
The two letter state abbreviation. | string | NJ |
Zip |
The postal code or zip. | string | 08540 |
County |
The county or jurisdiction. | string | Mercer |
Country |
The name of the country. | string | |
SPLC |
The Standard Point Location code to use in place of street/city/state/zip. | String | |
CountryPostalFilter |
The postal code filter; use this to filter zip codes by country. | Enum |
0 - US 1- Mexico 2 - Both |
AbbreviationFormat |
The abbreviation format for the country code. This is not applicable for NA dataset. See Lookup table in Glossary. | Enum |
0 - FIPS 1 - ISO2 2 - ISO3 3 - GENC2 4 - GENC3 |
CountryAbbreviation |
Abbreviated country code corresponding to requested format. | string |
| Data Element | Description | Data Type | Value/Example |
|---|---|---|---|
Lat |
Latitude | String | |
Lon |
Longitute | String |
| Data Element | Description | Data Type | Value/Example |
|---|---|---|---|
Type |
Indicates whether the error is an exception or warning | Enum | Warning Exception |
Code |
Error code | Enum | Please refer to Appendix for complete list |
LegacyErrorCode |
The legacy error code with is an integer valued code that would have been returned in PCMiler Web Services v25 and earlier. | int | |
Description |
The detailed error description. | String |