Trip Viewer
Contents
When you
plan a trip
, the Trip Management service includes in
its response
a url field, with a link to a web page titled “Trip Viewer.” Trip Viewer displays a map and details for the planned trip. It updates as the trip progresses, tracking things including:
- The driver’s current location.
- Planned and actual arrival and departure times, as well as the stop duration, for each stop in the trip.
- ETA alerts when a vehicle is expected to miss an estimated arrival time window for a stop.
- Out-of-Corridor alerts when a driver deviates from the planned route beyond a predetermined mileage threshold. (1 mile is the default.)
The map can also display the current weather radar, real-time traffic, and points of interest (like food and fuel).
Each Trip Viewer page is available for 12 hours after it is created. That time limit can be refreshed at any time with a call to the Get Trip or the Recalculate Trip APIs, which return updated links to the trip. For post-trip analysis, you can also call Get Trip to view a completed or canceled trip at any time within a year after the trip was planned.
Example Trip Viewer URL
"url": "https://tripmanagement.alk.com/trip-viewer/token/ejvhhgguyf45m7tbdcgubmpsixfh5a3tycj3yci3ep/details/96301560?region=NA"
Trip Viewer
The main elements of a Trip Viewer page are described below.
The Map
The Trip Viewer map details the route, the driver’s location, and any alerts triggered by the driver.
Map Icons
Weather and Traffic
The map layers button turns on or off the display of the current weather radar, real-time traffic, and points of interest (like food and fuel).
Follow Driver
The Follow Driver button zooms the maps to the driver’s last reported location.
Event notifications
If any ETA or Out-of-Corridor alerts occur during the trip, pop-up messages will appear on the map. Out-of-Corridor alerts appear when the driver has left or rejoined the route corridor.
Timeline and Trip Details
Below the map, a timeline displays the progress of the trip, using the same icons as seen on the map. Each stop and waypoint on the trip are also described in detail and updated throughout the trip.
- The address of the work stop, rest stop, or waypoint.
- The status of the stop – open, arrived, completed, or canceled.
- The estimated or actual arrival time at the stop.
- The arrival time window in the planned trip, which is used to trigger ETA notifications.
- The estimated or actual departure time from the stop.
- The estimated or actual stop duration.