routes

Get Suggested Driver

Suggest a driver to assign to a route: the active driver most familiar with the route's locations (by past completed deliveries), excluding drivers already assigned within the given route group.

Parameters: route_id (UUID): The route to suggest a driver for. route_group_id (UUID): The route group the assignment is within. session (AsyncSession): The database session dependency.

Returns: The suggested driver, or null if there's no candidate.

get/api/routes/{route_id}/suggested-driver

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

route_idstring uuid required

Query parameters

route_group_idstring uuid required

Route group the route is being assigned within

Response

Successful Response

driver_idstring uuid required
driver_namestring required

Changes

No recorded changes to this operation across all 1 revision of this API.