Optibus Private Hires API is one of 26 APIs that Optibus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Private Hires. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes
4 operations
across 4 paths,
and defines 118 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.
The identity and technical contract details declared by the specification.
PrivateHireServerErrorResponse
object
1 property
PrivateHireErrorServer
object
2 properties
2 required
ExternalPrivateHireErrorTypesEnum.InvalidEventTimeFormat
string
PrivateHireErrorDepotName
object
3 properties
3 required
PrivateHireWarningInvalidLabelCodeDetails
object
3 properties
2 required
ISO8601Time
string
Representation of the time in ISO8601 format, where the minimum is at the start of the operational day (12am night) and the maximum 12 hours the day after the…
PrivateHireTripNotFoundError
object
3 properties
3 required
PrivateHireOrderDoesNotHavePrivateHiresError
object
3 properties
3 required
UpdatePrivateHireTripLockedNotAllowedError
object
3 properties
3 required
PrivateHireErrorInvalidEventTimeFormat
object
3 properties
3 required
PrivateHireErrorDuplicateTaskIdDetails
object
1 property
1 required
ExternalPrivateHireErrorTypesEnum.InvalidEventsChronologicalOrder
string
TaskDisplayIdString
string
External identifier of a private hire trip that should be unique within the system and that will be used internally in Optibus as the display ID.
PrivateHireErrorResponse
object
1 property
PrivateHireErrorMultipleRegions
object
3 properties
3 required
ExternalPrivateHireErrorTypesEnum.PrivateHiresEmpty
string
PrivateHireWarningResponse
object
1 property
ExternalPrivateHireErrorTypesEnum.ConflictProcessingRequest
string
ExternalPrivateHireErrorTypesEnum.InvalidDepotName
string
OtherEventTypes.PullIn
string
ExternalPrivateHireErrorTypesEnum.EventTimeNotWithin36Hours
string
ExternalPatchPrivateHireTripErrorTypesEnum.UpdatePrivateHireTripRegionNotAllowed
string
ExternalPrivateHireErrorTypesEnum.PrivateHireEventsEmpty
string
PatchPrivateHireOrderTripsNotFoundError
OnScheduleEventsTypes.Custom
string
PrivateHireErrorInvalidOrderIdFormatDetails
object
1 property
1 required
ExternalPrivateHireErrorTypesEnum.InvalidEventsTimeOverlap
string
ExternalPatchPrivateHireTripErrorTypesEnum.UpdatePrivateHireTripLockedNotAllowed
string
OnScheduleEventsTypes.Break
string
OnScheduleEventsTypes.Deadhead
string
OtherEventTypes.PrivateHire
string
PrivateHireErrorEventOverlap
object
3 properties
3 required
ExternalPatchPrivateHireErrorTypesEnum.OrderAlreadyCancelled
string
Pick_DriverBaseInformation.id-or-firstName-or-lastName_
object
From T, pick a set of properties whose keys are in the union K
3 properties
3 required
Undefinable_ISOWithTimeDate_
ExternalPatchPrivateHireTripErrorTypesEnum.PrivateHireTripsWithoutChanges
string
UpdatePrivateHireTripLockedNotAllowedErrorDetails
object
1 property
1 required
Pick_PrivateHireTask.taskId-or-depotName-or-date-or-note_
object
From T, pick a set of properties whose keys are in the union K
4 properties
3 required
PrivateHireLocation
object
4 properties
1 required
PrivateHireErrorEmptyPrivateHires
object
2 properties
2 required
PatchPrivateHireOrderRequestError
ExternalPrivateHireErrorTypesEnum.PrivateHiresNonUnique
string
PrivateHireWarningInvalidLabelCode
object
3 properties
3 required
GetPrivateHireOrderResponseError
UpdatePrivateHireTripRegionNotAllowedDetails
object
4 properties
4 required
PrivateHireAPIEvent
object
8 properties
5 required
PrivateHireErrorEventChronologicalOrder
object
3 properties
3 required
PrivateHireConflictProcessingRequestError
object
2 properties
2 required
PrivateHiresNonUniqueError
object
3 properties
3 required
SupportedOrderStatus
string
Private hire order status. - confirmed: the order is meant to have been paid by the hiring entity. In the OPS Optibus platform, when a trip has any driver or v…
PrivateHireErrorDuplicateTaskIds
object
3 properties
3 required
ExternalPrivateHireErrorTypesEnum.TaskIdsAlreadyExists
string
PatchPrivateHireOrderResponse
object
1 property
UpdatePrivateHireTripCancelledNotAllowedErrorDetails
object
1 property
1 required
PrivateHireEventInResponse
object
8 properties
4 required
PrivateHireErrorBeyond36Hours
object
3 properties
3 required
PrivateHireErrorDepotNameDetails
object
6 properties
3 required
UpdatePrivateHireTripRegionNotAllowedError
object
3 properties
3 required
ExternalPrivateHireWarningTypesEnum.InvalidLabelCode
string
ExternalPrivateHireErrorTypesEnum.OrderIdAlreadyExists
string
Pick_PrivateHireTask.taskId_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
PrivateHireTaskInResponse
PrivateHireErrorDuplicateOrderIdDetails
object
1 property
1 required
PatchPrivateHireOrderTripsBadRequestErrorResponse
object
1 property
PrivateHireErrorEmptyEvents
object
2 properties
2 required
Omit_PreferencesLabel.type_
Construct a type with the properties of T except for those in type K.
PrivateHireOrderNonExistentError
object
3 properties
3 required
PrivateHireErrorDuplicateOrderId
object
3 properties
3 required
HourMinuteDuration
string
Representation of the time in HH:mm format, where the minimum is 00:00 and maximum 36:00 (12:00 at noon the day after)
PatchPrivateHireTripsBodyRequest
object
1 property
1 required
UpdatePrivateHireTripCancelledNotAllowedError
object
3 properties
3 required
PatchPrivateHireOrderBodyRequest
object
1 property
1 required
PrivateHireOrderInResponse
object
3 properties
3 required
PostPrivateHireOrderRequest
object
3 properties
2 required
PrivateHireErrorEventTimeDetails
object
2 properties
2 required
PatchPrivateHireOrderNotExistResponse
object
1 property
ExternalPrivateHireErrorWarning
ExternalPrivateHireErrorTypesEnum.InvalidEventsTimeOrder
string
PatchPrivateHireOrderTripsNotFoundErrorResponse
object
1 property
ConflictProcessingRequestErrorResponse
object
1 property
PrivateHireTripNotFoundDetails
object
2 properties
2 required
ExternalPrivateHireErrorTypesEnum.DepotsForMultipleRegionsError
string
ExternalPrivateHireErrorTypesEnum.InvalidOrderIdFormat
string
PatchPrivateHireOrderTripsBadRequestError
Undefinable_Pick_DriverBaseInformation.id-or-firstName-or-lastName__
ExternalPatchPrivateHireErrorTypesEnum.OrderNonExistent
string
ExternalPatchPrivateHireErrorTypesEnum.OrderAlreadyConfirmed
string
PrivateHireOrderError
object
1 property
1 required
PrivateHireTask
object
7 properties
4 required
OtherEventTypes.PullOut
string
Pick_Vehicle.id_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 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
ExternalPatchPrivateHireErrorTypesEnum.OrderDoesNotHavePrivateHires
string
ISOWithTimeDate
string
Stringified ISO8601 date in the form of 2017-07-21T23:59:00+03:00
PrivateHireErrorMultipleRegionsDetails
array
PrivateHireTripsWithoutChangesError
object
2 properties
2 required
PrivateHireErrorEventTime
object
3 properties
3 required
PrivateHireErrorTaskDateDetails
object
2 properties
2 required
PrivateHireErrorInvalidOrderIdFormat
object
3 properties
3 required
ExternalPrivateHireErrorTypesEnum.ServerError
string
Pick_Vehicle.licensePlate-or-type-or-model-or-availableSeats_
object
From T, pick a set of properties whose keys are in the union K
4 properties
OrderIdString
string
External identifier of a private hire order that should be unique within the system
GetPrivateHireOrderResponse
PrivateHireOrderAlreadyConfirmedError
object
3 properties
3 required
PatchPrivateHireCancellation
ExternalPatchPrivateHireTripErrorTypesEnum.PrivateHireTripNotFound
string
PrivateHireOrderAlreadyCancelledError
object
3 properties
3 required
ExternalPrivateHireErrorTypesEnum.InvalidDateFormat
string
PrivateHireErrorTaskDate
object
3 properties
3 required
PrivateHiresNonUniqueDetails
object
1 property
1 required
ExternalPatchPrivateHireTripErrorTypesEnum.UpdatePrivateHireTripCancelledNotAllowed
string
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Optibus publishes across the network.
