Derived Route

The /derivedRoute/routePath GET request 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.

(Note: Requires a license for access to Trimble MAPS JavaScript.)

Derived Route Path Request

GET

URL Parameters

Required parameters are highlighted in yellow.

Response

Loading...
      
      
      
    

Derived Route Path Response

Data ElementDescriptionData TypeValue/Example
typeIndicates the type of responsestring
geometryThe route points of the route that was runGeoJson Geometry

Geometry

Data ElementDescriptionData TypeValue/Example
TypeIndicates the type of geometrystringMultistring(currently this is the only value)
CoordinatesA series of geographic coordinate points that make up a routeJson array of arrays