RoutePath Report

The Route Path Report retrieves a series of geographic coordinates that make up a route. The route is generated using the parameters below.

Requires a license for access to Trimble MAPS JavaScript.

Parameters

This table includes the most frequently used parameters. Please see the Route Reports 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. Check the box next to any additional parameters you would like to set. The RoutePath report is available for PC*MILER 24 and higher.

RoutePath Request

API KEY
GET

Response

RoutePath Report Response

Data ElementDescriptionData Type
typeIndicates the type of response
string
geometryThe route points of the route that was runGeoJson Geometry
TMinutesThe trip’s total times in minutes.
double
TDistanceThe trip’s total distance in miles.
double
vehiclerestrictedcleanupgeometryList of coordinates that represents the path from the drivable road network to a stop located on a pedestrian only road. (This is usually the path the driver has walk to reach a stop on a vehicle-restricted road.) This path, if one exists, is only returned when includeVehicleRestrictedCleanupPoints is set to true in the request.GeoJson Geometry

Geometry

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