Location Webservice

Geocode address

Get the latitude and longitude of an address

post/api/location/geoCode

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/location/geoCode
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

addressstring nullable

Address to geocode

Example request

{
  "address": "1600 Pennsylvania Avenue NW, Washington, DC"
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
latitudenumber double nullable

Latitude coordinate of the address

longitudenumber double nullable

Longitude coordinate of the address

warningMsgstring nullable

Example response

{
  "latitude": 38.8977,
  "longitude": -77.0365
}

Changes

No recorded changes to this operation across all 1 revision of this API.