Derived Route

The Derived Route API estimates the route a vehicle took based on a series of longitude/latitude coordinates (usually pings from the vehicle). The function works this way:

  1. PC*MILER generates a route between the origin and destination.
  2. The latitude/longitude pings are compared with that route.
  3. Any pings that fall outside of the distance set in the offRouteMiles parameter are considered significant, and the route is reshaped to incorporate them.
  4. The estimated route is returned as a list of trip coordinates in GeoJSON format.

Requires a license for access to Trimble MAPS JavaScript.

GET /derivedRoute/routePath

Parameters

This table includes the most frequently used parameters. Please see the Route Geometry overview page for a full list. If you would like to test out this API, enter values in the table below and scroll down the page to submit your request. Required parameters are highlighted in yellow.

Request

API KEY
GET

Response

Derived Route Path Response

Data Element Description Data Type Value/Example
type Indicates the type of response
string
geometry The route points of the route that was run GeoJson Geometry

Geometry

Data Element Description Data Type Value/Example
Type Indicates the type of geometry
string
Multistring (currently this is the only value)
Coordinates A series of geographic coordinate points that make up a route Json array of arrays