{ "opencollection": "1.0.0", "info": { "name": "Optibus Operations Driver Absences Operational Plan API", "version": "2.8.17" }, "items": [ { "info": { "name": "Operational Plan", "type": "folder" }, "items": [ { "info": { "name": "Fetch operational plan (v2)", "type": "http" }, "http": { "method": "GET", "url": "https://YOUR-OPTIBUS-ACCOUNT.api.ops.optibus.co/v2/operational-plan", "params": [ { "name": "fromDate", "value": "", "type": "query", "description": "- Returns the operational plans from this date (both fromDate and toDate are required). Date format is YYYY-MM-DD" }, { "name": "toDate", "value": "", "type": "query", "description": "- Returns the daily operational plans to this date (both fromDate and toDate are required). Date format is YYYY-MM-DD" }, { "name": "depotUuids", "value": "72999313-c6d3-44a3-9e64-a8cbce779ed7,e09cc074-b949-4d39-97b5-d2fa5eb1cdc5", "type": "query", "description": "- When specified, the response will contain only these depots. When including more than one depot the request param can be a comma separated list (eg depotUuids=A,B) or you can use several request params (eg depotUuids=A?depotUuids=B)\"" }, { "name": "driverUuids", "value": "", "type": "query", "description": "- When specified, the response wil include only assignments for these drivers. When including more than one driver the request param can be a comma separated list (eg driverUuids=A,B) or you can use several request params (eg driverUuids=A?driverUuids=B)" }, { "name": "includeStops", "value": "", "type": "query", "description": "- When true, the response will include a full stop list on each trip. Otherwise only origin and destination are included in request. (Usage may cause requests to take a long time)" }, { "name": "includeUnassigned", "value": "", "type": "query", "description": "- In conjunction with supplying driver ids, When true return unassigned tasks as well as assigned tasks according to the driver filter." }, { "name": "fetchPlannedAssignmentsProperties", "value": "", "type": "query", "description": "- When true, the response will include the properties of the plannedAssignments" }, { "name": "taskDisplayIds", "value": "T100,T200,T300", "type": "query", "description": "- When specified, filters tasks, blocks, task assignments, and block assignments to only include those associated with the provided task display IDs. Can be a comma separated list (eg taskDisplayIds=T1,T2)" }, { "name": "excludeCancelledTasks", "value": "", "type": "query", "description": "- When true, exclude cancelled (disabled) tasks from driverAssignments, vehicleAssignments, and plannedAssignments. Defaults to false." }, { "name": "includeActualSigningTimes", "value": "", "type": "query", "description": "- When true, include actual signing times (signOnActual, signOffActual) in assignment properties attributes. Times are ISO 8601 datetime strings in the customer's operational timezone (no UTC offset), or null if the driver has not yet signed. Defaults to false." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns the daily operational plans for a specified date range. This endpoint provides comprehensive operational data including tasks, assignments, blocks, drivers, and vehicles.\n\n**Spare Types Support**: When the spare types feature flag is enabled, spare tasks will include additional properties:\n- `spareType`: The spare type code (e.g., \"SPARE1\", \"SPARE2\")\n- `displayId`: Will show the configured spare type name instead of the original display ID\n- `dutyType`: Will be set to \"spare\" for spare t" }, { "info": { "name": "List calendar planned assignments", "type": "http" }, "http": { "method": "GET", "url": "https://YOUR-OPTIBUS-ACCOUNT.api.ops.optibus.co/calendar-planned-assignments", "params": [ { "name": "depotId", "value": "", "type": "query", "description": "- Returns the calendar planned assignments for this depot ID" }, { "name": "startDate", "value": "", "type": "query", "description": "- Returns the calendar planned assignments from this date (both startDate and endDate are required)" }, { "name": "endDate", "value": "", "type": "query", "description": "- Returns the calendar planned assignments to this date (both startDate and endDate are required)" }, { "name": "assignedOnly", "value": "", "type": "query", "description": "- optional. When true, the response will *only* contain planned assignments that have drivers assigned to them" }, { "name": "driverIds", "value": "", "type": "query", "description": "- optional. Returns the calendar planned assignments for the filtered driver IDs (when this filter is used, the response won't include unassigned tasks)" }, { "name": "fetchStops", "value": "", "type": "query", "description": "- optional. When true, the response will *also* contain the tasks stops" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns the calendar planned assignments and tasks, with filters.\n\n**Spare Types Support**: When the spare types feature flag is enabled, spare tasks will include additional properties:\n- `spareType`: The spare type code (e.g., \"SPARE1\", \"SPARE2\")\n- `displayId`: Will show the configured spare type name instead of the original display ID\n- `dutyType`: Will be set to \"spare\" for spare tasks\n- `startTime` and `endTime`: Will be included in the task summary for spare tasks based on the relevant spar" }, { "info": { "name": "List driver day labels", "type": "http" }, "http": { "method": "GET", "url": "https://YOUR-OPTIBUS-ACCOUNT.api.ops.optibus.co/v1/calendar-driver-day-labels", "params": [ { "name": "fromDate", "value": "", "type": "query", "description": "- Returns the driver day labels from this date (both fromDate and toDate are required)" }, { "name": "toDate", "value": "", "type": "query", "description": "- Returns the the driver day labels to this date (both fromDate and toDate are required)" }, { "name": "driverIds", "value": "", "type": "query", "description": "- optional. Returns the driver day labels for the filtered driver IDs" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Returns the calendar planned assignments and tasks, with filters." } ] } ], "bundled": true }