Skip to main content
GET
Find Nearest Locations

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

customerId
string
required

Query Parameters

longitude
number<double>

The longitude value for the point. Must be specified if latitude has been specified.

latitude
number<double>

The latitude value for the point. Must be specified if longitude has been specified.

radius
number<double>
required

The radius (in km) of the search area. Must be greater than or equal to 1.0 and cannot be more than 500.

maximumResultsToReturn
integer<int32>
required

Maximum number of locations to return. Must be greater than 0.

road
string

Name of a road.

roadNumber
string

Road number.

city
string

City

country
string

Country.

postCode
string

Post code.

Response

200 - application/json;charset=UTF-8

Successful operation

id
string

Unique, unchangeable system generated identifier (alphanumeric) for the location.

name
string

Location name.

straightLineDistanceKilometers
number<double>

Distance (as the crow flies) in km to the location.