| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
Display name of route |
string |
Required String length: inclusive between 1 and 100 |
| StartTime |
Specifies the start time for the route |
date |
None. |
| StopTime |
Specifies the stop time for the route |
date |
None. |
| HardStart |
Specifies if the route has a specific start time |
boolean |
Required |
| HardStop |
Specifies if the route has a specific end time |
boolean |
Required |
| Stops |
List of stops on the route |
Collection of AddStopModel |
Required |
| OptType |
Set what optimization mode to use for the route (default = fastest) |
OptTypeEnum |
None. |
| Note |
Note to be displayed for the route |
string |
None. |
| TravelMode |
Set what transportation mode to use for the route (default = driving) |
TravelModeEnum |
None. |
| Driver |
Specifies which (if any) driver is assigned to the route |
string |
None. |
| IsRoundTrip |
Specifies if the route is round trip |
boolean |
None. |
| StartLocation |
Specifies the start location for the route |
LatLng |
None. |