Get Bussing Optimize | SchoolSet

curl https://app.schoolset.io/app/api/v1/bussing/optimize/details/route_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "status": "success",
  "message": "Optimization details retrieved successfully for route ID 5A12B7",
  "data": {
    "routeId": "5A12B7",
    "optimizationRunId": "OPT20240615-001",
    "totalStops": 24,
    "totalBusesUsed": 3,
    "totalDistanceKm": 48.7,
    "estimatedDurationMinutes": 95,
    "startTime": "2024-06-15T07:30:00Z",
    "endTime": "2024-06-15T09:05:00Z",
    "buses": [
      {
        "busId": "BUS-102",
        "driverName": "Alice Johnson",
        "capacity": 40,
        "stopsAssigned": 8,
        "distanceKm": 16.2,
        "durationMinutes": 32
      },
      {
        "busId": "BUS-103",
        "driverName": "Mark Thompson",
        "capacity": 40,
        "stopsAssigned": 9,
        "distanceKm": 17.5,
        "durationMinutes": 35
      },
      {
        "busId": "BUS-104",
        "driverName": "Sofia Martinez",
        "capacity": 40,
        "stopsAssigned": 7,
        "distanceKm": 15,
        "durationMinutes": 28
      }
    ],
    "optimizationParameters": {
      "maxRideTimeMinutes": 45,
      "maxBusCapacity": 40,
      "routePriority": "minimize_distance"
    }
  }
}

Returns optimization details for the selected bus route or optimization run.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Path parameters

route_idstringRequired

Response

Successful GET response for /api/v1/bussing/optimize/details/{route_id}.

statusenum

Allowed values:

messagestring

datamap from strings to any