Route Cards
Use to retrieve PDF-format Route Cards containing navigation instructions for drivers to complete a route. These cards contain a route summary and directions to each stop.
POSThttps://routecloud.telogis.com/v1/route_cards.- Authentication required.
- Request body: problem with optional parameters.
| Name | Type | Description |
|---|---|---|
| problem | problem | The problem that contains the sandbox data. |
| use_metric | boolean | Optional. Use miles or kilometers. Defaults to miles. |
| use_miltary_time | boolean | Optional. Use miltary (24-hour) time or standard time. Defaults to standard time. |
| map_visibility | integer | Optional. Determines which maps are in the route cards. Accepted values are 0 no maps, 1 all maps, 2 summary map. Defaults to no maps (0). |
| time_zone_utc_offset | timespan | Optional. Sets the timezone in which which the dates and times are located. |
| routes | route response | Optional. List of already evaluated routes. |
Status Codes
200- Success.400- The input problem was invalid. The response is an error_response.401- Authentication required.
Example
For example, sending POST https://routecloud.telogis.com/v1/route_cards?wait=1 with the body:
{
"use_metric": true,
"use_miltary_time": true,
"map_visibility": 1,
"problem": {
"id": "Problem0",
"markers": [{
"id": "Marker0",
"location": "-43.552723,172.634758"
}],
"jobs": [{
"id": "Job0",
"location": "-43.549062, 172.642059"},
{
"id": "Job1",
"location": "-43.544839, 172.628252"
}],
"drivers": [{
"id": "Driver0",
"name": "Driver 0"
},
{
"id": "Driver1",
"name": "Driver 1"
}],
"routes": [{
"id": "Route0",
"location":"Marker0",
"driver": "Driver0",
"jobs": ["Job0", "Job1"]
}
]
}
}
Which returns the download url.
See Also
- The problem type.