You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modes/passenger-services.md
+24-2Lines changed: 24 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,6 +36,8 @@ Taxis typically require explicit tracking of maintenance while TNCs typically do
36
36
37
37
The short name identifier for Passenger Services used across MDS is `passenger-services`.
38
38
39
+
[Top][toc]
40
+
39
41
## Trip Properties
40
42
41
43
### Journey ID
@@ -56,18 +58,24 @@ Example 2: three shared trips, some overlapping
56
58
<- Trip: reservation -><- Trip: shared ->
57
59
```
58
60
61
+
[Top][toc]
62
+
59
63
### Journey Attributes
60
64
61
65
The `journey_attributes` array **may** have the following key value pairs:
62
66
63
67
- ...
64
68
65
-
#### Trip ID Requirements
69
+
[Top][toc]
70
+
71
+
### Trip ID Requirements
66
72
67
73
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`, or `driver_cancellation`.
68
74
69
75
Additionally, `trip_id` is required if `event_types` contains a `enter_jurisdiction` or `leave_jurisdiction` event pertaining to a passenger trip.
70
76
77
+
[Top][toc]
78
+
71
79
### Trip Type
72
80
73
81
The `trip_type` field **must** have one of the following enumerated values:
@@ -77,6 +85,8 @@ The `trip_type` field **must** have one of the following enumerated values:
77
85
-`reservation`: en route to pickup a customer who has made a reservation, with no passengers in the vehicle
78
86
-`empty`: vehicle movement with no passengers (outside of other `trip_type` values) that may need to be reported, e.g. for deadheading
79
87
88
+
[Top][toc]
89
+
80
90
### Trip Attributes
81
91
82
92
The `trip_attributes` array **may** have the following key value pairs:
@@ -90,6 +100,8 @@ The `trip_attributes` array **may** have the following key value pairs:
90
100
-`permit_licence_number` (string, optional) - The permit licence number of the organization that dispatched the vehicle
91
101
-`driver_id` (string, optional): Universal identifier of a specific driver, static across operators, like a driver's license number. Could also be used as a lookup in an agency's internal driver system.
92
102
103
+
[Top][toc]
104
+
93
105
### Fare Attributes
94
106
95
107
The `fare_attributes` array **may** have the following key value pairs:
@@ -108,6 +120,8 @@ The `fare_attributes` array **may** have the following key value pairs:
108
120
-`driver_trip_pay` (currency, optional) - The payment the driver received for the trip
109
121
-`rate_code_id` (enumerated, optional) - one of `meter_fare`, `shared`, `out_of_town`, `disabled`, `upfront_pricing`, `promo_rate`
110
122
123
+
[Top][toc]
124
+
111
125
## Vehicle Properties
112
126
113
127
### Vehicle Attributes
@@ -122,14 +136,18 @@ The `vehicle_attributes` array **may** have the following key value pairs:
122
136
-`placard_number` (string, optional) - the registered placard number of the vehicle
123
137
-`inspection_date` (date YYYY-MM-DD, optional) - the date of the last inspection of the vehicle
124
138
139
+
[Top][toc]
140
+
125
141
### Accessibility Options
126
142
127
143
This `accessibility_options` enum represents the accessibility options available on a given vehicle, or the accessibility options utilized for a given trip.
|`wheelchair_accessible`| This vehicle is wheelchair accessible |
132
148
149
+
[Top][toc]
150
+
133
151
## State Machine
134
152
135
153
### Vehicle States
@@ -228,12 +246,16 @@ This is the list of `vehicle_state` and `event_type` pairings that constitute th
228
246
|`unknown`|`reserved`|`reserved`|`comms_restored`| The vehicle has come back into comms while reserved by a passenger |
229
247
|`unknown`|`stopped`|`stopped`|`comms_restored`| The vehicle has come back into comms while stopped |
230
248
249
+
[Top][toc]
250
+
231
251
### State Machine Diagram
232
252
233
253
The *Passenger Services 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](https://drive.google.com/file/d/1WusVpFK1Vm7HSJgNcA_10T74TEzuCpTB/view?usp=sharing) for the source file.
234
254
235
255

236
256
257
+
[Top][toc]
258
+
237
259
#### Passenger Services State Notes
238
260
239
261
When there is only one trip ongoing, `trip_state == vehicle_state`
0 commit comments