Route Path
The Route Path API retrieves a series of geographic coordinates that make up a route. The route is generated using the parameters below.
The Route Path can also be generated as one of the reports in our Route Reports API.
Requires a license for access to Trimble MAPS JavaScript.
GET /route/routePath
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 | |
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 |