Optibus Operational Plan (Deprecated) API
These API endpoints are deprecated and could be removed in a future version. Please use GET /v2/operational-plan instead.
Optibus Operational Plan (Deprecated) API is one of 26 APIs that Optibus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Operational Plan (Deprecated). The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes 2 operations across 2 paths, and defines 299 schemas. It is described by OpenAPI 3.0.0, at version 2.8.17.
Requests are made against a single base URL, https://YOUR-OPTIBUS-ACCOUNT.api.ops.optibus.co.
2 operations
2 paths
299 schemas
2 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Optibus Operational Plan (Deprecated) API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (api_key).
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.
Operational Plan (Deprecated) 2
These API endpoints are deprecated and could be removed in a future version. Please use GET /v2/operational-plan instead.
GET
/v1/operational-plan/{depotId}deprecated
Fetch depot operational plan
GET
/v1/operational-plandeprecated
Fetch operational plan
Schemas 299
The contract defines 299 schemas that model the data the API accepts and returns. The most detailed are Vehicle (44 properties), Pick_OnScheduleServiceTripEvent.Exclude_keyofOnScheduleServiceTripEvent.stops-or-id__ (16 properties), Partial_Simplify_Record_ValueOf_StopPropertyMap_.string___ (16 properties), DutyEventSummary (13 properties). Each schema is shown below with its type and property counts.
TaskEventBase_BehindTheWheelHoursEventJsonData.CustomScheduleEventsTypes.BehindTheWheelHours_
ReliefCarEventsTypes.ReliefCarDriver
string
PrivateHireEventJsonData
RosterEvent_ReinforcementTripEventJsonData.OtherEventTypes.ReinforcementTrip_
TaskEventBase_DeadheadEventJsonData.DeadheadSubType_
UUID
string
Stringified ID for a resource. Cannot exceed 36 characters.
GenericRosterEventProps_PostTripEventJsonData_
object
3 properties
3 required
TechnicalBreakEventJsonData
TrainingEventJsonData
TaskEventBase_CustomEventJsonData.OnScheduleEventsTypes.Custom_
_RefuelEvent
RosterEvent_TrainingEventJsonData.CustomScheduleEventsTypes.Training_
EventStop
Pick_SameLocationEvent.Exclude_keyofSameLocationEvent.stops-or-id__
object
From T, pick a set of properties whose keys are in the union K
2 properties
CustomScheduleEventsTypes.Standby
string
GenericRosterEventProps_SignOffEventJsonData_
object
3 properties
3 required
LightDutyHoursEventJsonData
CustomScheduleEventsTypes.TechnicalBreak
string
OnScheduleEventsTypes.ReliefCar
string
Partial_Pick_OtherTravelEvent.name__
object
Make all properties in T optional
1 property
GenericRosterEventProps_NonRevenueEventJsonData_
object
3 properties
3 required
Pick_OtherTravelEvent.Exclude_keyofOtherTravelEvent.stops-or-id-or-name__
object
From T, pick a set of properties whose keys are in the union K
2 properties
ServiceTripEventJsonData
GenericRosterEventProps_DeadheadEventJsonData_
object
3 properties
3 required
BreakEvent
TechnicalBreakEvent
StringId
string
The name of an entity that is also used as its identifier (ID)
Omit_RefuelEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
VehicleEmission
number
TaskEventBase_ReliefCarPassengerEventJsonData.ReliefCarEventsTypes.ReliefCarPassenger_
RosterEvent_ServiceTripEventJsonData.OnScheduleEventsTypes.ServiceTrip_
EventsRef
object
Unique ID combination to get full event data from events property
2 properties
2 required
BaseEventJsonData
Passenger
The driver as a passenger. Events that can have drivers as passengers: service | idle | taxi | reliefCar
TaskEventBase_BreakEventJsonData.OnScheduleEventsTypes.Break_
SignOffEventJsonData
VehicleTypology
number
OnScheduleEventsTypes.Split
string
Omit_OnScheduleDeadheadEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
DepotOperationalPlan
VehicleClass
number
Pick_ReliefCarTravelEvent.Exclude_keyofReliefCarTravelEvent.stops-or-id__
object
From T, pick a set of properties whose keys are in the union K
4 properties
OtherEventTypes.PullIn
string
TaskEventBase_ReliefCarDriverEventJsonData.ReliefCarEventsTypes.ReliefCarDriver_
Omit_OnScheduleCustomEvent.stops-or-id-or-description_
Construct a type with the properties of T except for those in type K.
ScheduleSourceMeta
object
3 properties
3 required
TaskEventBase_ReinforcementTripEventJsonData.OtherEventTypes.ReinforcementTrip_
SignOnEvent
ExternalCalendarTaskSummaryWithLocationSummary
TaskEventBase_PostTripEventJsonData.OnScheduleEventsTypes.PostTrip_
TaskEventBase_TaxiEventJsonData.OnScheduleEventsTypes.Taxi_
ReinforcementTripEvent
TrainingEvent
AttributeValue
TaskEventBase_ServiceTripEventJsonData.OnScheduleEventsTypes.ServiceTrip_
OptibusTime
string
Time as HH:MM:SS between 24:00:00 and 47:59:59 is next day between 48:00:00 and 71:59:59 is the day after that a leading "-"" represents the previous day (eg -…
SubTripMeta
object
7 properties
Omit_SameLocationEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
RosterEvent_ReliefCarPassengerEventJsonData.ReliefCarEventsTypes.ReliefCarPassenger_
RechargeEventJsonData
LocationInformation
object
This type is used to map the event to the stops in the real world. remark: for same location events, the origin and the destination are the same.
2 properties
TaskEventBase_MeetingEventJsonData.CustomScheduleEventsTypes.Meeting_
DeadheadSubType
GenericRosterEventProps_AttendanceEventJsonData_
object
3 properties
3 required
BreakEventJsonData
SplitEventJsonData
Pick_OnScheduleCustomEvent.Exclude_keyofOnScheduleCustomEvent.stops-or-id__
object
From T, pick a set of properties whose keys are in the union K
3 properties
1 required
RosterEvent_SplitEventJsonData.OnScheduleEventsTypes.Split_
BehindTheWheelHoursEvent
CustomEventStop
Custom event related data. Custom stops cannot be found in the stops catalog/property Their ID is actually their name and lat and long are stored directly in t…
CustomScheduleEventsTypes.Meeting
string
RosterDutyEventReference
object
5 properties
2 required
Omit_OtherTravelEvent.stops-or-id-or-name_
Construct a type with the properties of T except for those in type K.
Pick_PublicTransportationEvent.Exclude_keyofPublicTransportationEvent.stops-or-id__
object
From T, pick a set of properties whose keys are in the union K
4 properties
1 required
OnScheduleEventsTypes.Custom
string
MeetingEventJsonData
Omit_RechargeEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
Vehicle
object
44 properties
2 required
OnScheduleEventsTypes.Break
string
Omit_TravelEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
GenericRosterEventProps_OtherTravelEventJsonData_
object
3 properties
3 required
StandbyEventJsonData
Label
GenericRosterEventProps_ReliefCarEventJsonData_
object
3 properties
3 required
CustomScheduleEventsTypes.Training
string
ReliefCarEventJsonData
Omit_OnScheduleServiceTripEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
CustomScheduleEventsTypes.BehindTheWheelHours
string
Omit_ReliefCarTravelEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
PostTripEventJsonData
ServiceTripTypeEvent
OnScheduleEventsTypes.PostTrip
string
TaskEvent
OnScheduleEventsTypes.Deadhead
string
TravelTypeEvent
OtherEventTypes.PrivateHire
string
SplitEvent
TaskEventProps
object
6 properties
OtherTaskEvent
Pick_OnScheduleCustomEvent.Exclude_keyofOnScheduleCustomEvent.stops-or-id-or-description__
object
From T, pick a set of properties whose keys are in the union K
2 properties
RosterEvent_BehindTheWheelHoursEventJsonData.CustomScheduleEventsTypes.BehindTheWheelHours_
GenericRosterEventProps_BehindTheWheelHoursEventJsonData_
object
3 properties
3 required
OnScheduleEventsTypes.Taxi
string
AssignmentProperties
SignOffEvent
ScheduleEventsTypeName
string
RosterEvent_PostTripEventJsonData.OnScheduleEventsTypes.PostTrip_
SameLocationTypeEvent
RosterEvent_DeadheadEventJsonData.DeadheadSubType_
OnScheduleEventsTypes.PublicTravel
string
RosterEvent_NonRevenueEventJsonData.CustomScheduleEventsTypes.NonRevenue_
Partial_Coordinates_
object
Make all properties in T optional
2 properties
MeetingEvent
EventStringId
string
Unique identifier for a scheduling event
OnScheduleEventsTypes
string
TaskEventBase_RechargeEventJsonData.OnScheduleEventsTypes.Recharge_
OnScheduleEventsTypes.Recharge
string
VehicleEvent
AssignmentType
string
BlockEvent
ReliefCarPassengerEvent
TaskEventBase_SignOnEventJsonData.OnScheduleEventsTypes.SignOn_
TaskEventBase_SignOffEventJsonData.OnScheduleEventsTypes.SignOff_
ExternalCalendarTaskBase_ExternalCalendarTaskSummaryWithLocationSummary_
ExternalCalendarTaskEvent_TaskEvent_
Record_string.unknown_
object
Construct a type with a set of properties K of type T
RosterEvent_ReliefCarEventJsonData.OnScheduleEventsTypes.ReliefCar_
EventWithBlock
BehindTheWheelHoursEventJsonData
OperationalPlans
object
1 property
1 required
OtherTravelsEvent
PublicTravelEventJsonData
OtherEventTypes
string
GenericRosterEventProps_CustomEventJsonData_
object
3 properties
3 required
CalendarBlock
OnScheduleEventsTypes.PreTrip
string
GenericRosterEventProps_ServiceTripEventJsonData_
object
3 properties
3 required
GenericRosterEventProps_TrainingEventJsonData_
object
3 properties
3 required
ExternalTaskEventProps
object
2 properties
2 required
ReliefCarEventsTypes
string
Pick_OnScheduleServiceTripEvent.Exclude_keyofOnScheduleServiceTripEvent.stops-or-id__
object
From T, pick a set of properties whose keys are in the union K
16 properties
3 required
TaskEventBase_TechnicalBreakEventJsonData.CustomScheduleEventsTypes.TechnicalBreak_
SourceMeta
PostTripEvent
GenericRosterEventProps__distance_63_-number_-and-PrivateHireEventJsonData_
object
3 properties
3 required
MinutesFromMidnightTime
integer
Wall clock time, represented as minutes since midnight. For example, 0 is midnight (start of the day), 120 is 02:00 (2 hours after midnight), 180 is 02:30 (2.5…
OnScheduleEventsTypes.Other
string
RosterEvent_PublicTravelEventJsonData.OnScheduleEventsTypes.PublicTravel_
CustomScheduleEventsTypes
string
Duty schedule only custom event, vehicle does not move between stops
RosterEvent_SignOffEventJsonData.OnScheduleEventsTypes.SignOff_
LightDutyHoursEvent
OnScheduleEventStop
object
Stop event related data. Full stop information should be taken from stops property with this stop id
3 properties
2 required
GenericRosterEventProps_MeetingEventJsonData_
object
3 properties
3 required
PublicTravelEvent
TaskEventBase_TrainingEventJsonData.CustomScheduleEventsTypes.Training_
TaskEventBase_LightDutyHoursEventJsonData.CustomScheduleEventsTypes.LightDutyHours_
RosterEvent_CustomEventJsonData.OnScheduleEventsTypes.Custom_
RosterEvent_StandbyEventJsonData.CustomScheduleEventsTypes.Standby_
Pick_OnScheduleDeadheadEvent.Exclude_keyofOnScheduleDeadheadEvent.stops-or-id__
object
From T, pick a set of properties whose keys are in the union K
10 properties
2 required
Omit_OnScheduleTaxiEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
SubTripEvent
GenericRosterEventProps_SignOnEventJsonData_
object
3 properties
3 required
PrivateHireEvent
DeadheadEventJsonData
TaskEventBase_SubTripEventJsonData.OnScheduleEventsTypes.SubTrip_
GetOperationalPlanV1Response
RosterEvent_WalkEventJsonData.OnScheduleEventsTypes.Walks_
ServiceTripEvent
ReinforcementTripEventJsonData
RosterEvent_OtherTravelEventJsonData.OnScheduleEventsTypes.OtherTravels_
OnScheduleEventsTypes.ServiceTrip
string
NonVehicleEvent
CustomTypeEvents
Pick_CalendarTask.Exclude_keyofCalendarTask.events-or-summary-or-disabled-or-cancellationCode-or-cancellationReason__
object
From T, pick a set of properties whose keys are in the union K
10 properties
3 required
Omit_PreferencesLabel.type_
Construct a type with the properties of T except for those in type K.
GenericRosterEventProps_BreakEventJsonData_
object
3 properties
3 required
RosterEvent_ReliefCarDriverEventJsonData.ReliefCarEventsTypes.ReliefCarDriver_
WalksEvent
Direction
number
Route trip direction
Omit_PublicTransportationEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
DeadheadTypeEvent
CustomEventJsonData
ReinforcementTripEventBase
object
1 property
1 required
OptibusIds
object
4 properties
2 required
TaskEventBase_OtherEventJsonData.OnScheduleEventsTypes.Other_
AttendanceEvent
AssignmentDayInformation
object
5 properties
5 required
RosterEvent_AttendanceEventJsonData.OnScheduleEventsTypes.Attendance_
RosterEvent_SignOnEventJsonData.OnScheduleEventsTypes.SignOn_
Integer
integer
Partial_Omit_OnScheduleBreakEvent.stops-or-id__
object
Make all properties in T optional
3 properties
DriverAssignments
object
2 properties
1 required
GenericRosterEventProps_ReinforcementTripEventJsonData_
object
3 properties
3 required
BlockId
object
1 property
OnScheduleEventsTypes.OtherTravels
string
Record_AttributeId.AttributeValue_
object
Construct a type with a set of properties K of type T
GenericRosterEventProps_ReliefCarDriverEventJsonData_
object
3 properties
3 required
StringifyDate
string
Stringified ISO8601 date in the form of YYYY-MM-dd, for example 2017-07-21
Omit_SameLocationDutyEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
OtherEventTypes.ReinforcementTrip
string
NonRevenueEventJsonData
CustomScheduleEventsTypes.NonRevenue
string
RosterEvent_LightDutyHoursEventJsonData.CustomScheduleEventsTypes.LightDutyHours_
VehiclePropulsion
number
GetDepotOperationalPlanV1Response
PublicTravelPassenger
object
2 properties
2 required
RosterEvent_OtherEventJsonData.OnScheduleEventsTypes.Other_
OnScheduleEventsTypes.Refuel
string
_RechargeEvent
TaskEventBase_OtherTravelEventJsonData.OnScheduleEventsTypes.OtherTravels_
OtherTravelEventJsonData
GenericRosterEventProps_OtherEventJsonData_
object
3 properties
3 required
Omit_OnScheduleCustomEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
DutyCancellationReason
object
2 properties
2 required
BlockType
string
Pick_TaskAssignment.taskId-or-labels-or-attributes-or-disabled-or-cancellationReason-or-opUnitUuid_
object
From T, pick a set of properties whose keys are in the union K
6 properties
1 required
OnScheduleEventsTypes.Attendance
string
Pick_OnScheduleTaxiEvent.Exclude_keyofOnScheduleTaxiEvent.stops-or-id__
object
From T, pick a set of properties whose keys are in the union K
5 properties
OnScheduleEventsTypes.SignOff
string
RosterEvent_RefuelEventJsonData.OnScheduleEventsTypes.Refuel_
VehicleAssignments
object
2 properties
1 required
RefuelEventJsonData
OnScheduleEventsTypes.SubTrip
string
DepotOperationalPlanBase
object
3 properties
3 required
RosterEvent__distance_63_-number_-and-PrivateHireEventJsonData.OtherEventTypes.PrivateHire_
TaskEventBase_ReliefCarEventJsonData.OnScheduleEventsTypes.ReliefCar_
GenericRosterEventProps_LightDutyHoursEventJsonData_
object
3 properties
3 required
CustomScheduleEventsTypes.LightDutyHours
string
ParentTripMeta
object
1 property
CustomEvent
ReliefCarEvent
OperationsSourceMeta
object
1 property
1 required
NonRevenueEvent
RosterEvent_BreakEventJsonData.OnScheduleEventsTypes.Break_
ReliefCarDriverEvent
SignOnEventJsonData
GenericRosterEventProps_PreTripEventJsonData_
object
3 properties
3 required
Record_string.AttributeValue_
object
Construct a type with a set of properties K of type T
GenericRosterEventProps_ReliefCarPassengerEventJsonData_
object
3 properties
3 required
TaskEventBase_RefuelEventJsonData.OnScheduleEventsTypes.Refuel_
TaskEventBase_StandbyEventJsonData.CustomScheduleEventsTypes.Standby_
OtherEventTypes.PullOut
string
TaskEventBase__distance_63_-number_-and-PrivateHireEventJsonData.OtherEventTypes.PrivateHire_
Pick_PreferencesLabel.Exclude_keyofPreferencesLabel.type__
object
From T, pick a set of properties whose keys are in the union K
2 properties
2 required
Pick_GetDriverResponse-at-number.uuid-or-id-or-firstName-or-lastName-or-middleName-or-archived_
object
From T, pick a set of properties whose keys are in the union K
6 properties
5 required
Stops
object
1 property
AttendanceEventJsonData
ExternalCalendarTaskWithLocationSummary
TaskType
string
Pick_RechargeEvent.Exclude_keyofRechargeEvent.stops-or-id__
object
From T, pick a set of properties whose keys are in the union K
5 properties
Pick_SameLocationDutyEvent.Exclude_keyofSameLocationDutyEvent.stops-or-id__
object
From T, pick a set of properties whose keys are in the union K
1 property
ReliefCarEventsTypes.ReliefCarPassenger
string
RosterEvent_TechnicalBreakEventJsonData.CustomScheduleEventsTypes.TechnicalBreak_
SameDutyLocationTypeEvent
TaskEventBase_PreTripEventJsonData.OnScheduleEventsTypes.PreTrip_
TaxiEventJsonData
RosterEvent_RechargeEventJsonData.OnScheduleEventsTypes.Recharge_
GenericRosterEventProps_RefuelEventJsonData_
object
3 properties
3 required
GenericRosterEventProps_SubTripEventJsonData_
object
3 properties
3 required
GenericRosterEventProps_TaxiEventJsonData_
object
3 properties
3 required
ReliefCarDriverEventJsonData
LocationSummary
SubTripEventJsonData
RosterEvent_PreTripEventJsonData.OnScheduleEventsTypes.PreTrip_
TaxiEvent
DeadheadEvent
Pick_TravelEvent.Exclude_keyofTravelEvent.stops-or-id__
object
From T, pick a set of properties whose keys are in the union K
2 properties
Required_LocationInformation_
object
Make all properties in T required
2 properties
2 required
RosterEvent_SubTripEventJsonData.OnScheduleEventsTypes.SubTrip_
OnScheduleEventsTypes.Walks
string
Partial_BaseEventJsonData_
object
Make all properties in T optional
3 properties
GenericRosterEventProps_TechnicalBreakEventJsonData_
object
3 properties
3 required
PreTripEvent
RosterEvent_MeetingEventJsonData.CustomScheduleEventsTypes.Meeting_
Partial_Simplify_Record_ValueOf_StopPropertyMap_.string___
object
Make all properties in T optional
16 properties
EventWithoutBlock
GenericRosterEventProps_RechargeEventJsonData_
object
3 properties
3 required
GenericRosterEventProps_WalkEventJsonData_
object
3 properties
3 required
GenericRosterEventProps_PublicTravelEventJsonData_
object
3 properties
3 required
OtherEventJsonData
PreTripEventJsonData
RosterEvent_TaxiEventJsonData.OnScheduleEventsTypes.Taxi_
TaskEventBase_SplitEventJsonData.OnScheduleEventsTypes.Split_
TaskEventBase_PublicTravelEventJsonData.OnScheduleEventsTypes.PublicTravel_
Pick_RefuelEvent.Exclude_keyofRefuelEvent.stops-or-id__
object
From T, pick a set of properties whose keys are in the union K
3 properties
Omit_CalendarTask.events-or-summary-or-disabled-or-cancellationCode-or-cancellationReason_
Construct a type with the properties of T except for those in type K.
OnScheduleEventsTypes.SignOn
string
GenericRosterEventProps_SplitEventJsonData_
object
3 properties
3 required
TaskEventBase_NonRevenueEventJsonData.CustomScheduleEventsTypes.NonRevenue_
WalkEventJsonData
ReliefCarPassengerEventJsonData
TaskEventBase_AttendanceEventJsonData.OnScheduleEventsTypes.Attendance_
StandbyEvent
DutyEventSummary
object
13 properties
5 required
GenericRosterEventProps_StandbyEventJsonData_
object
3 properties
3 required
ScheduleEventsType
SignPost
object
1 property
VehicleBlockJsonData
object
1 property
1 required
TaskEventBase_WalkEventJsonData.OnScheduleEventsTypes.Walks_
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Optibus 12
Other APIs Optibus publishes across the network.
Optibus Driver Absences API
Optibus Driver App Notifications API
Optibus Driver Custom Attributes API
Optibus Driver Employment Periods API
Optibus Driver Groups API
Optibus Driver Volunteering Periods API
Optibus Drivers API
Optibus Drivers (Deprecated) API
Optibus Event Webhooks API
Optibus Operational Plan API
Optibus Payroll API
Optibus Preferences API
#Operational Plan (Deprecated)
Where this information came from
This is an independent, third-party profile of Optibus Operational Plan (Deprecated) API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.