POST Route Path
Contents
The Route Path POST request retrieves a series of geographic coordinate points that make up a route.
Requires a license for access to Trimble MAPS JavaScript.
POST /route/routePath?dataset={dataset}
Request Element
A POST routePath request requires a JSON formatted RoutePointsRequestBody object in the POST body.
| Parameter | Definition | Required |
|---|---|---|
dataset | The regional dataset. Possible value: Current (default), PCM_EU, PCM_OC, PCM_SA, PCM_AF, PCM_AS, PCM_ME, PCM_GT, PCM_WW, PCM_NA and PCM18-PCMXX (“XX” is the most current version of PC*MILER. Call /pcmversion to see the latest versions available.). | N |
Sample JSON POST Body
{
"Route": {
"Stops": [
{
"Coords": {
"Lat": "51.517749",
"Lon": "-0.171839"
},
"Region": 4
},
{
"Coords": {
"Lat": "51.518264",
"Lon": "-0.174080"
},
"Region": 4
},
{
"Coords": {
"Lat": "51.516322",
"Lon": "-0.17543"
},
"Region": 4
}
],
"Options": {
"BordersOpen": true,
"DistanceUnits": 0,
"HazMatType": 0,
"HighwayOnly": false,
"TruckCfg": {
"Weight": "9000",
"Axles": 6,
"Units": 0,
"LCV": false,
"Width": "8'0"
},
"RouteOptimization": 0,
"RoutingType": 0,
"VehicleType": 0,
"ClassOverrides": 3,
"OverrideRestrict": false,
"UseSideofStreet": false,
}
"ExtendedOptions":
{
"IncludeVehicleRestrictedCleanupPoints": true
}
}
}
Sample Response
{
"type": "Feature",
"geometry": {
"type": "MultiLineString",
"coordinates": [
[
[-0.171839, 51.517749],
[-0.171799, 51.517723],
[-0.17122, 51.51806],
[-0.171, 51.51819],
[-0.17112, 51.51821],
[-0.17117, 51.51822],
[-0.17121, 51.51822],
[-0.17137, 51.51818],
[-0.17143, 51.51817],
[-0.17148, 51.51816],
[-0.17194, 51.51809],
[-0.17276, 51.51795],
[-0.17383, 51.51776],
[-0.173856, 51.517756]
],
[
[-0.173856, 51.517756],
[-0.17529, 51.51751],
[-0.17567, 51.51743],
[-0.1758, 51.51738],
[-0.17597, 51.51729],
[-0.17624, 51.51715],
[-0.17624, 51.51714],
[-0.17624, 51.51713],
[-0.17624, 51.51712],
[-0.17611, 51.51703],
[-0.17586, 51.51685],
[-0.17583, 51.5168],
[-0.17581, 51.51677],
[-0.1758, 51.51674],
[-0.1758, 51.5167],
[-0.1758, 51.51666],
[-0.17582, 51.51658],
[-0.17581, 51.51656],
[-0.1758, 51.51655],
[-0.17575, 51.51651],
[-0.175456, 51.516308],
[-0.17543, 51.516322]
]
]
},
"TMinutes": 2,
"TDistance": 0.356,
"properties": null,
"vehiclerestrictedcleanupgeometry": {
"type": "MultiLineString",
"coordinates": [
[
[-0.173856, 51.517756],
[-0.17408, 51.518264]
],
[
[-0.17408, 51.518264],
[-0.173856, 51.517756]
]
]
}
}