Optibus Operational Plan API
The Operational Plan API from Optibus — 3 operation(s) for operational plan.
Optibus Operational Plan 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. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes 3 operations across 3 paths, and defines 340 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.
3 operations
3 paths
340 schemas
3 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Optibus Operational Plan API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (api_key).
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.
Operational Plan 3
GET
/v2/operational-plan
Fetch operational plan (v2)
GET
/calendar-planned-assignments
List calendar planned assignments
GET
/v1/calendar-driver-day-labels
List driver day labels
Schemas 340
The contract defines 340 schemas that model the data the API accepts and returns. The most detailed are Vehicle (44 properties), Pick_DutyEventSummary-and-LocationSummary.Exclude_keyofDutyEventSummary-and-LocationSummary.originDepot-or-originStop-or-destinationDepot-or-destinationStop__ (21 properties), Pick_OnScheduleServiceTripEvent.Exclude_keyofOnScheduleServiceTripEvent.stops-or-id__ (16 properties), DutyEventSummary (13 properties). Each schema is shown below with its type and property counts.
TaskEventBase_BehindTheWheelHoursEventJsonData.CustomScheduleEventsTypes.BehindTheWheelHours_
PrivateHireEventJsonData
RosterEvent_ReinforcementTripEventJsonData.OtherEventTypes.ReinforcementTrip_
GenericRosterEventProps_PostTripEventJsonData_
object
3 properties
3 required
TrainingEventJsonData
ExpandedTaskEventBase_PreTripEventJsonData.OnScheduleEventsTypes.PreTrip_
EventStop
GenericRosterEventProps_SignOffEventJsonData_
object
3 properties
3 required
CustomScheduleEventsTypes.Standby
string
BreakEvent
TechnicalBreakEvent
BaseEventJsonData
VehicleTypology
number
OnScheduleEventsTypes.Split
string
PlannedTaskAssignment
object
5 properties
1 required
Omit_OnScheduleCustomEvent.stops-or-id-or-description_
Construct a type with the properties of T except for those in type K.
TaskEventBase_ReinforcementTripEventJsonData.OtherEventTypes.ReinforcementTrip_
SignOnEvent
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
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
RechargeEventJsonData
BreakEventJsonData
ExpandedTaskEventBase_CustomEventJsonData.OnScheduleEventsTypes.Custom_
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
Omit_OtherTravelEvent.stops-or-id-or-name_
Construct a type with the properties of T except for those in type K.
MeetingEventJsonData
Omit_TravelEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
Label
CustomScheduleEventsTypes.BehindTheWheelHours
string
TravelTypeEvent
SplitEvent
ExpandedTaskEventBase_RechargeEventJsonData.OnScheduleEventsTypes.Recharge_
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
GenericRosterEventProps_BehindTheWheelHoursEventJsonData_
object
3 properties
3 required
OnScheduleEventsTypes.Taxi
string
SignOffEvent
RosterEvent_PostTripEventJsonData.OnScheduleEventsTypes.PostTrip_
ExpandedTaskEventBase_SubTripEventJsonData.OnScheduleEventsTypes.SubTrip_
MeetingEvent
EventStringId
string
Unique identifier for a scheduling event
TaskEventBase_SignOffEventJsonData.OnScheduleEventsTypes.SignOff_
Record_string.unknown_
object
Construct a type with a set of properties K of type T
OtherTravelsEvent
PublicTravelEventJsonData
ExternalTaskEventProps
object
2 properties
2 required
GenericRosterEventProps__distance_63_-number_-and-PrivateHireEventJsonData_
object
3 properties
3 required
SameLocationTypeEvent
PrivateHireEvent
Omit_OnScheduleTaxiEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
OnScheduleEventsTypes.ServiceTrip
string
RosterEvent_OtherTravelEventJsonData.OnScheduleEventsTypes.OtherTravels_
ReinforcementTripEventJsonData
RosterEvent_ReliefCarDriverEventJsonData.ReliefCarEventsTypes.ReliefCarDriver_
DeadheadTypeEvent
TaskEventBase_OtherEventJsonData.OnScheduleEventsTypes.Other_
AttendanceEvent
ExpandedTaskEventBase_ServiceTripEventJsonData.OnScheduleEventsTypes.ServiceTrip_
GenericRosterEventProps_ReinforcementTripEventJsonData_
object
3 properties
3 required
OtherEventTypes.ReinforcementTrip
string
RosterEvent_LightDutyHoursEventJsonData.CustomScheduleEventsTypes.LightDutyHours_
BlockType
string
OnScheduleEventsTypes.SubTrip
string
VehicleAssignments
object
2 properties
1 required
CustomScheduleEventsTypes.LightDutyHours
string
TaskEventBase_ReliefCarEventJsonData.OnScheduleEventsTypes.ReliefCar_
TaskEventBase__distance_63_-number_-and-PrivateHireEventJsonData.OtherEventTypes.PrivateHire_
TaskEventBase_RefuelEventJsonData.OnScheduleEventsTypes.Refuel_
AttendanceEventJsonData
Stops
object
1 property
ExpandedTaskEventBase_PostTripEventJsonData.OnScheduleEventsTypes.PostTrip_
Pick_SameLocationDutyEvent.Exclude_keyofSameLocationDutyEvent.stops-or-id__
object
From T, pick a set of properties whose keys are in the union K
1 property
GenericRosterEventProps_SubTripEventJsonData_
object
3 properties
3 required
ReliefCarDriverEventJsonData
TaxiEvent
GenericRosterEventProps_WalkEventJsonData_
object
3 properties
3 required
OtherEventJsonData
RosterEvent_TaxiEventJsonData.OnScheduleEventsTypes.Taxi_
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
AssignmentPropertiesV2
TaskEventBase_NonRevenueEventJsonData.CustomScheduleEventsTypes.NonRevenue_
ExternalCalendarTask
GenericRosterEventProps_StandbyEventJsonData_
object
3 properties
3 required
TaskEventBase_DeadheadEventJsonData.DeadheadSubType_
ExpandedTaskEventBase_DeadheadEventJsonData.DeadheadSubType_
CustomScheduleEventsTypes.TechnicalBreak
string
OnScheduleEventsTypes.ReliefCar
string
ServiceTripEventJsonData
ExpandedTaskEventBase_OtherTravelEventJsonData.OnScheduleEventsTypes.OtherTravels_
StringId
string
The name of an entity that is also used as its identifier (ID)
EventsRef
object
Unique ID combination to get full event data from events property
2 properties
2 required
Omit_OnScheduleDeadheadEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
ExpandedTaskEventBase_BehindTheWheelHoursEventJsonData.CustomScheduleEventsTypes.BehindTheWheelHours_
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
AttributeValue
ScheduleEventsTypeName
string
RosterEvent_ReliefCarPassengerEventJsonData.ReliefCarEventsTypes.ReliefCarPassenger_
DeadheadSubType
SplitEventJsonData
ExpandedTaskEventBase_LightDutyHoursEventJsonData.CustomScheduleEventsTypes.LightDutyHours_
BehindTheWheelHoursEvent
RosterDutyEventReference
object
5 properties
2 required
GenericRosterEventProps_OtherTravelEventJsonData_
object
3 properties
3 required
StandbyEventJsonData
CustomScheduleEventsTypes.Training
string
GetCalendarPlannedAssignmentsResponse
object
2 properties
2 required
ServiceTripTypeEvent
RosterEvent_BehindTheWheelHoursEventJsonData.CustomScheduleEventsTypes.BehindTheWheelHours_
OnScheduleEventsTypes.Recharge
string
ExternalCalendarTaskBase_Omit_DutyEventSummary-and-LocationSummary.originDepot-or-originStop-or-destinationDepot-or-destinationStop_-or-_type-TaskType__
AssignmentType
string
TaskEventBase_SignOnEventJsonData.OnScheduleEventsTypes.SignOn_
ExternalCalendarTaskEvent_TaskEvent_
BehindTheWheelHoursEventJsonData
OtherEventTypes
string
CalendarBlock
TaskEventBase_TechnicalBreakEventJsonData.CustomScheduleEventsTypes.TechnicalBreak_
ExpandedTaskEventBase_MeetingEventJsonData.CustomScheduleEventsTypes.Meeting_
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…
ExpandedTaskEventBase_SignOnEventJsonData.OnScheduleEventsTypes.SignOn_
PublicTravelEvent
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
SubTripEvent
GenericRosterEventProps_SignOnEventJsonData_
object
3 properties
3 required
DeadheadEventJsonData
GetOperationalPlanV2Response
array
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
GenericRosterEventProps_BreakEventJsonData_
object
3 properties
3 required
Direction
number
Route trip direction
ExternalCalendarTaskV2
RosterEvent_AttendanceEventJsonData.OnScheduleEventsTypes.Attendance_
Partial_Omit_OnScheduleBreakEvent.stops-or-id__
object
Make all properties in T optional
3 properties
DriverAssignments
object
2 properties
1 required
BlockId
object
1 property
CustomScheduleEventsTypes.NonRevenue
string
NonRevenueEventJsonData
PublicTravelPassenger
object
2 properties
2 required
RosterEvent_OtherEventJsonData.OnScheduleEventsTypes.Other_
TaskEventBase_OtherTravelEventJsonData.OnScheduleEventsTypes.OtherTravels_
OtherTravelEventJsonData
GenericRosterEventProps_OtherEventJsonData_
object
3 properties
3 required
DutyCancellationReason
object
2 properties
2 required
OnScheduleEventsTypes.SignOff
string
RefuelEventJsonData
RosterEvent__distance_63_-number_-and-PrivateHireEventJsonData.OtherEventTypes.PrivateHire_
ParentTripMeta
object
1 property
ReliefCarDriverEvent
SignOnEventJsonData
GenericRosterEventProps_PreTripEventJsonData_
object
3 properties
3 required
ExternalCalendarTaskBase_ExternalCalendarTaskSummary_
GenericRosterEventProps_ReliefCarPassengerEventJsonData_
object
3 properties
3 required
TaskType
string
ExpandedTaskEventBase_SplitEventJsonData.OnScheduleEventsTypes.Split_
ReliefCarEventsTypes.ReliefCarPassenger
string
GenericRosterEventProps_RefuelEventJsonData_
object
3 properties
3 required
ExpandedTaskEventBase_ReliefCarEventJsonData.OnScheduleEventsTypes.ReliefCar_
OnScheduleEventsTypes.Walks
string
ExpandedTaskEventBase_ReliefCarDriverEventJsonData.ReliefCarEventsTypes.ReliefCarDriver_
ExpandedTaskEventBase_WalkEventJsonData.OnScheduleEventsTypes.Walks_
PreTripEventJsonData
GenericRosterEventProps_SplitEventJsonData_
object
3 properties
3 required
TaskEventBase_AttendanceEventJsonData.OnScheduleEventsTypes.Attendance_
ScheduleEventsType
SignPost
object
1 property
Pick_DutyEventSummary-and-LocationSummary.Exclude_keyofDutyEventSummary-and-LocationSummary.originDepot-or-originStop-or-destinationDepot-or-destinationStop__
object
From T, pick a set of properties whose keys are in the union K
21 properties
3 required
TechnicalBreakEventJsonData
TaskEventBase_CustomEventJsonData.OnScheduleEventsTypes.Custom_
_RefuelEvent
Pick_SameLocationEvent.Exclude_keyofSameLocationEvent.stops-or-id__
object
From T, pick a set of properties whose keys are in the union K
2 properties
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
ExpandedTaskEventsWithBlock
VehicleEmission
number
RosterEvent_ServiceTripEventJsonData.OnScheduleEventsTypes.ServiceTrip_
Passenger
The driver as a passenger. Events that can have drivers as passengers: service | idle | taxi | reliefCar
ExpandedTaskEventBase_PublicTravelEventJsonData.OnScheduleEventsTypes.PublicTravel_
TaskEventBase_ReliefCarDriverEventJsonData.ReliefCarEventsTypes.ReliefCarDriver_
ScheduleSourceMeta
object
3 properties
3 required
TaskEventBase_TaxiEventJsonData.OnScheduleEventsTypes.Taxi_
TaskEventBase_ServiceTripEventJsonData.OnScheduleEventsTypes.ServiceTrip_
TaskEventBase_MeetingEventJsonData.CustomScheduleEventsTypes.Meeting_
CustomEventJsonData
Omit_SameLocationEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
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
GenericRosterEventProps_AttendanceEventJsonData_
object
3 properties
3 required
Vehicle
object
44 properties
2 required
ExpandedTaskEventBase_SignOffEventJsonData.OnScheduleEventsTypes.SignOff_
GetOperationalPlanV2Element
ExpandedTaskEventBase_AttendanceEventJsonData.OnScheduleEventsTypes.Attendance_
ReliefCarEventJsonData
ExpandedTaskEventBase_PrivateHireEventJsonData.OtherEventTypes.PrivateHire_
OnScheduleEventsTypes.PostTrip
string
OnScheduleEventsTypes.Deadhead
string
OtherEventTypes.PrivateHire
string
TaskEventProps
object
6 properties
RosterEvent_NonRevenueEventJsonData.CustomScheduleEventsTypes.NonRevenue_
Partial_Coordinates_
object
Make all properties in T optional
2 properties
TaskEventBase_RechargeEventJsonData.OnScheduleEventsTypes.Recharge_
BlockEvent
ExpandedTaskEventBase_TaxiEventJsonData.OnScheduleEventsTypes.Taxi_
ExpandedTaskEventBase_StandbyEventJsonData.CustomScheduleEventsTypes.Standby_
RosterEvent_ReliefCarEventJsonData.OnScheduleEventsTypes.ReliefCar_
GenericRosterEventProps_CustomEventJsonData_
object
3 properties
3 required
GenericRosterEventProps_TrainingEventJsonData_
object
3 properties
3 required
ReliefCarEventsTypes
string
ExternalCalendarTaskSummary
SourceMeta
OnScheduleEventsTypes.Other
string
RosterEvent_PublicTravelEventJsonData.OnScheduleEventsTypes.PublicTravel_
Record_AttributeId.AttributeValue_
object
Construct a type with a set of properties K of type T
RosterEvent_SignOffEventJsonData.OnScheduleEventsTypes.SignOff_
OnScheduleEventStop
object
Stop event related data. Full stop information should be taken from stops property with this stop id
3 properties
2 required
ExpandedTaskEventBase_PreTripEventJsonData.OtherEventTypes.ReinforcementTrip_
GenericRosterEventProps_MeetingEventJsonData_
object
3 properties
3 required
ServiceTripEvent
NonVehicleEvent
CustomTypeEvents
Omit_PreferencesLabel.type_
Construct a type with the properties of T except for those in type K.
OptibusIds
object
4 properties
2 required
ExpandedTaskEventBase_TechnicalBreakEventJsonData.CustomScheduleEventsTypes.TechnicalBreak_
StringifyDate
string
Stringified ISO8601 date in the form of YYYY-MM-dd, for example 2017-07-21
OnScheduleEventsTypes.Refuel
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
RosterEvent_RefuelEventJsonData.OnScheduleEventsTypes.Refuel_
ReliefCarEvent
NonRevenueEvent
RosterEvent_BreakEventJsonData.OnScheduleEventsTypes.Break_
Record_string.AttributeValue_
object
Construct a type with a set of properties K of type T
TaskEventBase_StandbyEventJsonData.CustomScheduleEventsTypes.Standby_
OtherEventTypes.PullOut
string
AssignmentDayInformationV2
object
5 properties
5 required
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_RechargeEvent.Exclude_keyofRechargeEvent.stops-or-id__
object
From T, pick a set of properties whose keys are in the union K
5 properties
Omit_DutyEventSummary-and-LocationSummary.originDepot-or-originStop-or-destinationDepot-or-destinationStop_
Construct a type with the properties of T except for those in type K.
RosterEvent_TechnicalBreakEventJsonData.CustomScheduleEventsTypes.TechnicalBreak_
SameDutyLocationTypeEvent
TaxiEventJsonData
RosterEvent_RechargeEventJsonData.OnScheduleEventsTypes.Recharge_
GenericRosterEventProps_TaxiEventJsonData_
object
3 properties
3 required
SubTripEventJsonData
RosterEvent_PreTripEventJsonData.OnScheduleEventsTypes.PreTrip_
Required_LocationInformation_
object
Make all properties in T required
2 properties
2 required
GenericRosterEventProps_TechnicalBreakEventJsonData_
object
3 properties
3 required
RosterEvent_MeetingEventJsonData.CustomScheduleEventsTypes.Meeting_
ReliefCarPassengerEventJsonData
StandbyEvent
VehicleBlockJsonData
object
1 property
1 required
TaskEventBase_WalkEventJsonData.OnScheduleEventsTypes.Walks_
ReliefCarEventsTypes.ReliefCarDriver
string
ExpandedTaskEventBase_OtherEventJsonData.OnScheduleEventsTypes.Other_
UUID
string
Stringified ID for a resource. Cannot exceed 36 characters.
RosterEvent_TrainingEventJsonData.CustomScheduleEventsTypes.Training_
LightDutyHoursEventJsonData
GenericRosterEventProps_DeadheadEventJsonData_
object
3 properties
3 required
ExpandedTaskEventsNotRequiringBlockId
Omit_RefuelEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
TaskEventBase_ReliefCarPassengerEventJsonData.ReliefCarEventsTypes.ReliefCarPassenger_
Omit_RosterEvent.eventJsonData-or-eventId_
Construct a type with the properties of T except for those in type K.
TaskEventBase_BreakEventJsonData.OnScheduleEventsTypes.Break_
SignOffEventJsonData
OtherEventTypes.PullIn
string
TaskEventBase_PostTripEventJsonData.OnScheduleEventsTypes.PostTrip_
ReinforcementTripEvent
TrainingEvent
GetDriverDayLabelsResponse
array
RosterEvent_SplitEventJsonData.OnScheduleEventsTypes.Split_
CustomScheduleEventsTypes.Meeting
string
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…
Omit_RechargeEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
OnScheduleEventsTypes.Break
string
GenericRosterEventProps_ReliefCarEventJsonData_
object
3 properties
3 required
Omit_OnScheduleServiceTripEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
Omit_ReliefCarTravelEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
PostTripEventJsonData
ExpandedTaskEventsRequiringBlockId
TaskEvent
ExpandedTaskEventBase_TrainingEventJsonData.CustomScheduleEventsTypes.Training_
OnScheduleEventsTypes.PublicTravel
string
RosterEvent_DeadheadEventJsonData.DeadheadSubType_
OnScheduleEventsTypes
string
ExpandedTaskEventBase_NonRevenueEventJsonData.CustomScheduleEventsTypes.NonRevenue_
VehicleEvent
ReliefCarPassengerEvent
EventWithBlock
OnScheduleEventsTypes.PreTrip
string
GenericRosterEventProps_ServiceTripEventJsonData_
object
3 properties
3 required
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
CalendarDailyPlannedInformation
object
2 properties
2 required
PostTripEvent
ExternalExpandedTaskEvent_ExpandedTaskEvent_
LightDutyHoursEvent
CustomScheduleEventsTypes
string
Duty schedule only custom event, vehicle does not move between stops
TaskEventBase_TrainingEventJsonData.CustomScheduleEventsTypes.Training_
TaskEventBase_LightDutyHoursEventJsonData.CustomScheduleEventsTypes.LightDutyHours_
RosterEvent_CustomEventJsonData.OnScheduleEventsTypes.Custom_
RosterEvent_StandbyEventJsonData.CustomScheduleEventsTypes.Standby_
TaskEventBase_SubTripEventJsonData.OnScheduleEventsTypes.SubTrip_
RosterEvent_WalkEventJsonData.OnScheduleEventsTypes.Walks_
ExpandedTaskEventBase_RefuelEventJsonData.OnScheduleEventsTypes.Refuel_
WalksEvent
Omit_PublicTransportationEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
ExpandedTaskEventBase_BreakEventJsonData.OnScheduleEventsTypes.Break_
ReinforcementTripEventBase
object
1 property
1 required
RosterEvent_SignOnEventJsonData.OnScheduleEventsTypes.SignOn_
Integer
integer
OnScheduleEventsTypes.OtherTravels
string
GenericRosterEventProps_ReliefCarDriverEventJsonData_
object
3 properties
3 required
Omit_SameLocationDutyEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
VehiclePropulsion
number
ExpandedTaskEventBase_ReliefCarPassengerEventJsonData.ReliefCarEventsTypes.ReliefCarPassenger_
Omit_OnScheduleCustomEvent.stops-or-id_
Construct a type with the properties of T except for those in type K.
_RechargeEvent
OnScheduleEventsTypes.Attendance
string
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.
CustomEvent
GenericRosterEventProps_LightDutyHoursEventJsonData_
object
3 properties
3 required
OperationsSourceMeta
object
1 property
1 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
TaskEventBase_PreTripEventJsonData.OnScheduleEventsTypes.PreTrip_
Pick_TaskAssignment.taskId-or-labels-or-attributes-or-disabled-or-cancellationReason-or-opUnitUuid-or-lastAssignedDriverId_
object
From T, pick a set of properties whose keys are in the union K
7 properties
1 required
DepotOperationalPlanBaseV2
object
3 properties
3 required
Pick_TravelEvent.Exclude_keyofTravelEvent.stops-or-id__
object
From T, pick a set of properties whose keys are in the union K
2 properties
DeadheadEvent
RosterEvent_SubTripEventJsonData.OnScheduleEventsTypes.SubTrip_
Partial_BaseEventJsonData_
object
Make all properties in T optional
3 properties
EventWithoutBlock
PreTripEvent
Pick_RosterEvent.Exclude_keyofRosterEvent.eventJsonData-or-eventId__
object
From T, pick a set of properties whose keys are in the union K
3 properties
3 required
GenericRosterEventProps_RechargeEventJsonData_
object
3 properties
3 required
GenericRosterEventProps_PublicTravelEventJsonData_
object
3 properties
3 required
TaskEventBase_SplitEventJsonData.OnScheduleEventsTypes.Split_
OnScheduleEventsTypes.SignOn
string
WalkEventJsonData
DutyEventSummary
object
13 properties
5 required
DepotOperationalPlanV2
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 (Deprecated) API
Optibus Payroll API
Optibus Preferences API
#Operational Plan
Where this information came from
This is an independent, third-party profile of Optibus Operational Plan 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.