Skip to main content
GET
Find Nearest Vehicles

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

lastMovedStartDateTime
string<date-time>

Start date and time for filtering vehicles that moved after this time. Format: yyyy-MM-dd'T'HH:mm:ss in UTC.

lastMovedEndDateTime
string<date-time>

End date and time for filtering vehicles that moved before this time. Format: yyyy-MM-dd'T'HH:mm:ss in UTC.

longitude
number<double>

Longitude coordinate of the center point for the search radius. Required if using coordinate-based search.

latitude
number<double>

Latitude coordinate of the center point for the search radius. Required if using coordinate-based search.

radius
number<double>
required

Search radius in kilometers from the center point.

maximumResultsToReturn
integer<int32>
required

Maximum number of vehicle results to return.

road
string

Road name or street name for address-based search. At least one address component required if using address-based search.

roadNumber
string

Road number or house number for address-based search. At least one address component required if using address-based search.

city
string

City name for address-based search. At least one address component required if using address-based search.

country
string

Country name for address-based search. At least one address component required if using address-based search.

postCode
string

Postal code or postcode for address-based search. At least one address component required if using address-based search.

Response

200 - application/json;charset=UTF-8

Nearest vehicles found successfully.

id
string

Vehicle identifier

name
string

Vehicle friendly name

registration
string

Vehicle registration

straightLineDistanceKilometers
number<double>

Distance to the vehicle in kilometers