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.
RoutePath Request
RoutePath Report Response
| Data Element | Description | Data Type |
|---|---|---|
type | Indicates the type of response | string |
geometry | The route points of the route that was run | GeoJson Geometry |
TMinutes | The trip’s total times in minutes. | double |
TDistance | The trip’s total distance in miles. | double |
vehiclerestrictedcleanupgeometry | List 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 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 |