GET Geocode/GetGeocodeFromAddress?userkey={userkey}&address={address}&city={city}&state={state}&zip={zip}&country={country}
Returns a lat/lon from address.
Request Information
URI Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| userkey |
Userkey for the user. |
string |
Required |
| address |
Address of the field/customer/tank/ShipTo |
string |
Required |
| city |
City |
string |
Required |
| state |
State |
string |
Required |
| zip |
Zip |
string |
Required |
| country |
Country (Optional) |
string |
Required |
Body Parameters
Response Information
Resource Description
Returns a lat/lon from address.
ClsApiGeocodeResult| Name | Description | Type | Additional Information |
|---|---|---|---|
| Latitude | string | ||
| Longitude | string | ||
| Address | string | ||
| City | string | ||
| State | string | ||
| ZipCode | string | ||
| Country | string | ||
| Accuracy | string | ||
| ErrorMessage | string |
Response Formats
application/json, text/json
Sample:
{
"Latitude": "sample string 1",
"Longitude": "sample string 2",
"Address": "sample string 3",
"City": "sample string 4",
"State": "sample string 5",
"ZipCode": "sample string 6",
"Country": "sample string 7",
"Accuracy": "sample string 8",
"ErrorMessage": "sample string 9"
}
application/xml, text/xml
Sample:
<ClsApiGeocode.ClsApiGeocodeResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Geocode"> <Accuracy>sample string 8</Accuracy> <Address>sample string 3</Address> <City>sample string 4</City> <Country>sample string 7</Country> <ErrorMessage>sample string 9</ErrorMessage> <Latitude>sample string 1</Latitude> <Longitude>sample string 2</Longitude> <State>sample string 5</State> <ZipCode>sample string 6</ZipCode> </ClsApiGeocode.ClsApiGeocodeResult>