{
  "opencollection": "1.0.0",
  "info": {
    "name": "Optibus Operations Driver Absences Operational Plan (Deprecated) API",
    "version": "2.8.17"
  },
  "items": [
    {
      "info": {
        "name": "Operational Plan (Deprecated)",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Fetch depot operational plan",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://YOUR-OPTIBUS-ACCOUNT.api.ops.optibus.co/v1/operational-plan/:depotId",
            "params": [
              {
                "name": "depotId",
                "value": "",
                "type": "path",
                "description": "- Returns the daily operational plans for this depot ID"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "- Returns the operational plans from this date (both from and to are required)"
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "- Returns the daily operational plans to this date (both from and to are required)"
              },
              {
                "name": "driversIds",
                "value": "",
                "type": "query",
                "description": "- Returns the daily operational plans for the filtered driver IDs (when this filter is used, the response won't include unassigned tasks)"
              },
              {
                "name": "vehicleIds",
                "value": "",
                "type": "query",
                "description": "- Returns the daily operational plans for the filtered vehicle IDs (when this filter is used, the response won't include unassigned blocks)"
              },
              {
                "name": "includeStops",
                "value": "",
                "type": "query",
                "description": "-  When true, the response will include a full stop list on each trip (requests may take a long time or even time out)"
              },
              {
                "name": "assignedOnly",
                "value": "",
                "type": "query",
                "description": "- When true, the response will only contain tasks that have drivers assigned to them"
              },
              {
                "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)"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "**WARNING: This is deprecated - you should use `/v2/operational-plan` described below. This API will not be supported beyond 2024-06-30.** Returns the daily operational plans for a specified date range and a specific depot.\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- `"
        },
        {
          "info": {
            "name": "Fetch operational plan",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://YOUR-OPTIBUS-ACCOUNT.api.ops.optibus.co/v1/operational-plan",
            "params": [
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "- Returns the operational plans from this date (both from and to are required)"
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "- Returns the daily operational plans to this date (both from and to are required)"
              },
              {
                "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)"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "**WARNING: This is deprecated - you should use `/v2/operational-plan` described below. This API will not be supported beyond 2024-06-30.** Returns the daily operational plans for a specified date range for every depot.\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- `dutyT"
        }
      ]
    }
  ],
  "bundled": true
}