Fleet Solution API (1.0)

Download OpenAPI specification:Download

Get Fleet Solutions

query Parameters

offset	integer
limit	integer Default: 100
fromDate required	string <date>
toDate required	string <date>

Responses

Response samples

200

Content type

application/json

[{"fleetSolutionKey": 0,
"fleetSolutionId": "string",
"boundaryProfileKey": 0,
"boundaryProfileId": "string",
"branchKey": 0,
"truckProfileKey": "string",
"dispatchDate": "string"
}
]

Get Fleet Solution by DispatchDate

query Parameters

branchKey required	integer
dispatchDate required	string <date>

Responses

Response samples

200

Content type

application/json

{"fleetSolutionKey": 0,
"fleetSolutionId": "string",
"boundaryProfileKey": 0,
"boundaryProfileId": "string",
"branchKey": 0,
"truckProfileKey": "string",
"dispatchDate": "string",
"stats": {"key": "string",
"fleetSolutionKey": "string",
"fleetSolutionId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"dispatchDate": "string",
"stops": {"min": 0,
"max": 0,
"avg": 0,
"total": 0,
"avgCost": 0,
"avgOrders": 0,
"perHour": 0
},
"workHours": {"min": 0,
"max": 0,
"avg": 0,
"total": 0
},
"driveHours": {"min": 0,
"max": 0,
"avg": 0,
"total": 0
},
"miles": {"min": 0,
"max": 0,
"avg": 0,
"total": 0
},
"routes": {"total": 0,
"violated": 0,
"cost": {"min": 0,
"max": 0,
"avg": 0,
"total": 0
}
},
"orders": {"total": 0
},
"volumes": [{"key": 0,
"fleetSolutionStatsKey": 0,
"dispatchDate": "string",
"total": 0,
"qtyFieldId": 0,
"avg": 0,
"min": 0,
"max": 0,
"capacity": 0
}
]
}
}

Get Fleet Solution

path Parameters

fleetSolutionId

required

string

Responses

Response samples

200

Content type

application/json

{"fleetSolutionKey": 0,
"fleetSolutionId": "string",
"boundaryProfileKey": 0,
"boundaryProfileId": "string",
"branchKey": 0,
"truckProfileKey": "string",
"dispatchDate": "string",
"stats": {"key": "string",
"fleetSolutionKey": "string",
"fleetSolutionId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"dispatchDate": "string",
"stops": {"min": 0,
"max": 0,
"avg": 0,
"total": 0,
"avgCost": 0,
"avgOrders": 0,
"perHour": 0
},
"workHours": {"min": 0,
"max": 0,
"avg": 0,
"total": 0
},
"driveHours": {"min": 0,
"max": 0,
"avg": 0,
"total": 0
},
"miles": {"min": 0,
"max": 0,
"avg": 0,
"total": 0
},
"routes": {"total": 0,
"violated": 0,
"cost": {"min": 0,
"max": 0,
"avg": 0,
"total": 0
}
},
"orders": {"total": 0
},
"volumes": [{"key": 0,
"fleetSolutionStatsKey": 0,
"dispatchDate": "string",
"total": 0,
"qtyFieldId": 0,
"avg": 0,
"min": 0,
"max": 0,
"capacity": 0
}
]
}
}

Delete Fleet Solution

path Parameters

fleetSolutionId

required

string

Responses

Load Fleet Solution

Request Body schema: application/json

branchKey	integer
truckProfileKey required	number
boundaryProfileId	string
dispatchDate required	string <date>
orderKeys	Array of numbers

Responses

Request samples

Payload

Content type

application/json

{"branchKey": 0,
"truckProfileKey": 0,
"boundaryProfileId": "string",
"dispatchDate": "2019-08-24",
"orderKeys": [0
]
}