Model output
The modelOutput object of the output dataset includes the drivers and unassignedJobs objects.
unassignedJobs includes the IDs of any jobs and stops that could not be assigned during solving:
{
"modelOutput": {
"unassignedJobs": [
{
"id": "Job A",
"unassignedStops": [
"A1",
"A2"
]
}
]
}
}
drivers includes the drivers that were included in the input dataset and their shifts.
shifts includes the shift startTime, the itinerary which includes the visits they have been assigned for that shift, and the metrics for the individual shift which breakdown how the driver will spend their time during the shift.
metrics are also included for the entire schedule.
In the following dataset, Ann has been assigned two stops from a single job, and Beth has not been assigned any stops.
{
"modelOutput": {
"drivers": [
{
"id": "Ann",
"shifts": [
{
"id": "Ann Mon",
"startTime": "2027-02-01T09:00:00Z",
"itinerary": [
{
"id": "B1",
"arrivalTime": "2027-02-01T09:31:59Z",
"startServiceTime": "2027-02-01T09:31:59Z",
"departureTime": "2027-02-01T09:51:59Z",
"effectiveServiceDuration": "PT20M",
"travelTimeFromPreviousStandstill": "PT31M59S",
"travelDistanceMetersFromPreviousStandstill": 33381,
"load": [],
"kind": "STOP"
},
{
"id": "B2",
"arrivalTime": "2027-02-01T10:45:44Z",
"startServiceTime": "2027-02-01T10:45:44Z",
"departureTime": "2027-02-01T11:05:44Z",
"effectiveServiceDuration": "PT20M",
"travelTimeFromPreviousStandstill": "PT53M45S",
"travelDistanceMetersFromPreviousStandstill": 62123,
"load": [],
"kind": "STOP"
}
],
"metrics": {
"totalTravelTime": "PT1H54M35S",
"travelTimeFromStartLocationToFirstStop": "PT31M59S",
"travelTimeBetweenStops": "PT53M45S",
"travelTimeFromLastStopToEndLocation": "PT28M51S",
"totalTravelDistanceMeters": 127047,
"travelDistanceFromStartLocationToFirstStopMeters": 33381,
"travelDistanceBetweenStopsMeters": 62123,
"travelDistanceFromLastStopToEndLocationMeters": 31543,
"endLocationArrivalTime": "2027-02-01T11:34:35Z"
}
}
]
},
{
"id": "Beth",
"shifts": [
{
"id": "Beth Mon",
"startTime": "2027-02-01T09:00:00Z",
"itinerary": [],
"metrics": {
"totalTravelTime": "PT0S",
"travelTimeFromStartLocationToFirstStop": "PT0S",
"travelTimeBetweenStops": "PT0S",
"travelTimeFromLastStopToEndLocation": "PT0S",
"totalTravelDistanceMeters": 0,
"travelDistanceFromStartLocationToFirstStopMeters": 0,
"travelDistanceBetweenStopsMeters": 0,
"travelDistanceFromLastStopToEndLocationMeters": 0
}
}
]
}
]
}
}
Next
-
See the full API spec or try the online API.
-
Learn about Input metrics.