Import Route Plan Example
Skill level:

This example demonstrates a tool that can be built with an intermediate-level knowledge of the MyGeotab system. It is suitable for those who have a good understanding of the Geotab ecosystem and are comfortable with the MyGeotab SDK and leveraging the MyGeotab APIs within their projects.

This utility helps you import route plans to your account using comma separated values (CSV). Route plans in MyGeotab can be thought of as waypoints through a sequence of zones combined with a vehicle (which will drive the route) and some optional information about when that vehicle should depart from and make it to each waypoint. The input provided is parsed and if the specified device and all zone waypoints exist, a new route is saved to your account. Note that a route needs a minimum of two waypoints.
In this example
API Methods:Add Get
API Entities:Device Zone

Use the text box below to import multiple route plans at a time. Place each route plan on its own line as follows:

RouteName1,DeviceName1,ZoneName1|StartTime1|TripTime1|StopTime1|Distance1
RouteName2,DeviceName2,ZoneName1|StartTime1|||
RouteName3,DeviceName3,ZoneName1|StartTime1|||,ZoneName2|StartTime2|||
RouteName4,DeviceName4,ZoneName1|StartTime1|||,ZoneName2|StartTime2|||,ZoneName3|StartTime3|||

    Template

    Overview
    Below is a table containing the required parameters for the route plan.

    ParameterDescriptionRequired
    RouteNameName of the routeYes
    DeviceNameWhich device to assign to the routeYes
    ZoneNameName of a zone to include as a waypointYes
    StartTimeWhen the route will be driven (yyyy-mm-dd hh:mm:ss)Yes
    TripTimeEstimated time it will take to reach next the waypoint (hh:mm:ss)No
    StopTimeEstimated additional time the vehicle will spend at this stop (hh:mm:ss)No
    Distance (km)Estimated travel distance to the stopNo

    Parameter format example
    My Route 01,My Vehicle 01,Office Zone 1|2015-08-31T08:00:00.000Z|||,Office Zone 2|2015-08-31T10:00:00.000Z|||