Car Share refers to shared point-to-point and station-based mutli-passenger vehicles. Car Share typically has a driver who is the customer, and possibly one or more passengers or cargo.
See the modes overview for how the mode specific information below applies across MDS.
The short name identifier for Car Share used across MDS is car-share.
The journey_id field shall have a consistent value in overlapping trips for a single reservation period, e.g. trips taken by a customer between ignition states over the duration of their reservation. A reservation is the duration the customer has continuous exclusive access to the vehicle whether parked or in motion. Journeys may be point-to-point or multi-segment.
Example 1: customer makes a reservation and company delivers vehicle to customer, then one trip point-to-point by customer, ending reservation at destination
<- Journey ->
<- Trip: reservation -><- Trip: private ->
Example 2: Customer reservation for multiple days with trips for errands, gas, entertainment, etc
<- Journey ->
<- Trip: private -><- Trip: private -><- Trip: private -><- Trip: private -><- Trip: private ->
Example 3: one trip point-to-point with an employee moving the vehicle to a new location for maintenance
<- Journey ->
<- Trip: empty ->
The journey_attributes array may have the following key value pairs:
reservation_id(UUID, optional): unique identifier for an entire car share reservation, tied across multiple journeys and therefore trips.
Events require a valid trip_id in events where event_types contains reservation_start, reservation_stop, trip_start, trip_stop, trip_end, passenger_cancellation, provider_cancellation.
Additionally, trip_id is required if event_types contains a enter_jurisdiction or leave_jurisdiction event pertaining to a trip.
The trip_type field must have one of the following enumerated values:
private: a private trip made by one paying customer with one or more guestsreservation: en route to pickup a customer who has made a reservation, with no passengers in the vehicleempty: vehicle movement with no customer (outside of othertrip_typevalues) that may need to be reported, e.g. for maintenance
The trip_attributes array may have the following key value pairs:
hail_type(enumerated, required):phone_dispatch,phone,text,appapp_name(text, optional): name of the app used to reserve the trip which could be provider's app or 3rd party apppermit_licence_number(string, optional) - The permit licence number of the organization that dispatched the vehicledriver_id(string, optional): Universal identifier of a specific driver, static across operators, like a driver's license number, for company employees inreservationoremptytrip types, notprivatetrips. Could also be used as a lookup in an agency's internal driver system.
See more available trip attributes for any mode in the trips endpoint.
The fare_attributes array may have the following key value pairs:
payment_type(enumerated, required):cash,credit_card,mobile,voucher,no payment,testfare_type(enumerated, required):meter_fare,upfront_pricing,flat_rate. Indicator of which rate was charged.tolls(currency, optional) - Sum of any and all tolls charged for the trip, such as bridge tollsbase_rate(currency, optional) - Minimum fare to be charged as soon as the trip starts.exit_fee(currency, optional) - Fee to exit location, like an airportother_fees(currency, optional) - amount of any fees charged to the customer. Includes baggage fees, cleaning fee. Excludes other fees returned.tip(currency, optional) - amount of tip paid by customerextra_amount(currency, optional) - miscellaneous extra amounts charged to customer not covered by other fields.taxes(currency, optional) - amount of taxes paid for the ridesurcharge(currency, optional) - any surcharge pricing
See more available fare attributes for any mode in the trips endpoint.
The vehicle_attributes array may have the following key value pairs:
year(integer, required)make(string, required)model(string, required)color(string, required)vin(string, required) - the Vehicle Identification Number of the vehiclelicense_plate(string, required) - the registered external license plate number of the vehicleinspection_date(date YYYY-MM-DD, optional) - the date of the last inspection of the vehiclesnow_shovel(boolean, optional) - shovel for removing snow or ice from around vehicle or vehicle pathsnow_brush(boolean, optional) - brushes for removing snow or ice from vehiclebike_rack(boolean, optional) - car roof or trunk mounted bike rackpark_access(boolean, optional) - access pass to a national/regional/municipal park systemtoll_transponder(boolean, optional) - toll transponder for national/regional toll systemphone_charger(boolean, optional) - a place to charge your phonesunshade(boolean, optional) - sunshade avaialable (i.e. for windshield)
See more available vehicle attributes for any mode in the vehicles endpoint.
This accessibility_options enum represents the accessibility options available on a given vehicle, or the accessibility options utilized for a given trip.
accessibility_options |
Description |
|---|---|
wheelchair_accessible |
This vehicle is wheelchair accessible |
Valid car share vehicle states are
removedavailablenon_operationalreservedon_tripstoppedelsewhereunknown
See Vehicle States for descriptions.
Valid car share vehicle event types are
charging_startcharging_endcomms_lostcomms_restoreddriver_cancellationdecommissionfueling_startfueling_endmaintenance_endmaintenance_startpassenger_cancellationprovider_cancellationrecommissionremote_startremote_endreservation_cancelreservation_startservice_endservice_starttrip_canceltrip_endtrip_enter_jurisdictiontrip_leave_jurisdictiontrip_resumetrip_starttrip_stopunspecified
See vehicle Event Types for descriptions.
This is the list of vehicle_state and event_type pairings that constitute the valid transitions of the vehicle state machine.
Previous vehicle_state |
vehicle_state |
trip_state |
event_type |
Description |
|---|---|---|---|---|
available |
elsewhere |
N/A | leave_jurisdiction |
The vehicle has left jurisdictional boundaries while available for-hire |
available |
non_operational |
N/A | service_end |
The vehicle has went out of service (is unavailable for-hire) |
available |
reserved |
reserved |
reserve |
The vehicle was reserved by a passenger |
available |
unknown |
N/A | comms_lost |
The vehicle has went out of comms while available for-use |
elsewhere |
available |
N/A | enter_jurisdiction |
The vehicle has entered jurisdictional boundaries while available for-hire |
elsewhere |
non_operational |
N/A | enter_jurisdiction |
The vehicle has entered jurisdictional boundaries while not operating commercially |
elsewhere |
on_trip |
on_trip |
enter_jurisdiction |
The vehicle has entered jurisdictional boundaries while on a trip |
elsewhere |
reserved |
N/A | enter_jurisdiction |
The vehicle has entered jurisdictional boundaries while reserved by a customer |
elsewhere |
unknown |
N/A | comms_lost |
The vehicle has went out of comms while outside of jurisdictional boundaries |
non_operational |
available |
N/A | service_start |
The vehicle has went into service (is available for-hire) |
non_operational |
elsewhere |
N/A | leave_jurisdiction |
The vehicle has left jurisdictional boundaries while not operating commercially |
non_operational |
removed |
N/A | decommissioned |
The vehicle has been removed from the Provider's fleet |
non_operational |
removed |
N/A | maintenance_start |
The vehicle has entered the depot for maintenance |
non_operational |
unknown |
N/A | comms_lost |
The vehicle has went out of comms while not operating commercially |
on_trip |
elsewhere |
N/A | leave_jurisdiction |
The vehicle has left jurisdictional boundaries while on a trip |
on_trip |
stopped |
stopped |
trip_stop |
The vehicle has stopped while on a trip |
on_trip |
unknown |
N/A | comms_lost |
The vehicle has gone out of comms while on a trip |
removed |
non_operational |
N/A | maintenance_end |
The vehicle has left the depot |
removed |
non_operational |
N/A | recommissioned |
The vehicle has been re-added to the Provider's fleet after being previously decommissioned |
removed |
unknown |
N/A | comms_lost |
The vehicle has gone out of comms while removed |
reserved |
available |
N/A | driver_cancellation |
The driver has canceled the reservation |
reserved |
available |
N/A | passenger_cancellation |
The passenger has canceled the reservation |
reserved |
available |
N/A | provider_cancellation |
The provider has canceled the reservation |
reserved |
elsewhere |
N/A | leave_jurisdiction |
The vehicle has left the jurisdiction while in a reservation |
reserved |
stopped |
stopped |
reserve_stop |
The vehicle has stopped to pick up the passenger |
reserved |
unknown |
N/A | comms_lost |
The vehicle went out of comms while being reserved by a passenger |
stopped |
available |
N/A | driver_cancellation |
The driver has canceled the trip while either waiting for the passenger, or dropping them off |
stopped |
available |
N/A | passenger_cancellation |
The passenger has canceled the trip while the vehicle is waiting to pick them up, or they are being dropped off |
stopped |
available |
N/A | provider_cancellation |
The provider has canceled the trip while the vehicle is waiting for a passenger, or dropping them off |
stopped |
available |
N/A | trip_end |
The trip has been successfully completed |
stopped |
on_trip |
on_trip |
trip_resume |
Resume a trip that was previously stopped (e.g. picking up a friend to go to the airport with) |
stopped |
on_trip |
on_trip |
trip_start |
Start a trip |
stopped |
stopped |
stopped |
charging_start |
Start charging the device battery |
stopped |
stopped |
stopped |
charging_end |
End charging the device battery |
stopped |
stopped |
stopped |
fueling_start |
Start fueling the device with physical fuel |
stopped |
stopped |
stopped |
fueling_end |
End fueling the device with physical fuel |
stopped |
stopped |
stopped |
remote_start |
Remotely start the engine while vehicle is stopped, usually to charge battery or warm up |
stopped |
stopped |
stopped |
remote_end |
Remotely stop the engine while vehicle is already stopped |
stopped |
unknown |
N/A | comms_lost |
The vehicle has went out of comms while stopped |
unknown |
available |
N/A | comms_restored |
The vehicle has come back into comms while available for-hire |
unknown |
elsewhere |
N/A | comms_restored |
The vehicle has come back into comms while outside of jurisdictional boundaries |
unknown |
non_operational |
N/A | comms_restored |
The vehicle has come back into comms while not operating commercially |
unknown |
on_trip |
on_trip |
comms_restored |
The vehicle has come back into comms while on a trip |
unknown |
removed |
N/A | comms_restored |
The vehicle has come back into comms while removed |
unknown |
reserved |
reserved |
comms_restored |
The vehicle has come back into comms while reserved by a passenger |
unknown |
stopped |
stopped |
comms_restored |
The vehicle has come back into comms while stopped |
The Car Share State Machine Diagram shows how the vehicle_state and event_type relate to each other and how taxi vehicles can transition between states. See this text-editable EPS for the source file.
