Skip to content

Commit 4d69fd2

Browse files
authored
Add TOC links
1 parent 756982e commit 4d69fd2

1 file changed

Lines changed: 24 additions & 2 deletions

File tree

modes/passenger-services.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ Taxis typically require explicit tracking of maintenance while TNCs typically do
3636

3737
The short name identifier for Passenger Services used across MDS is `passenger-services`.
3838

39+
[Top][toc]
40+
3941
## Trip Properties
4042

4143
### Journey ID
@@ -56,18 +58,24 @@ Example 2: three shared trips, some overlapping
5658
<- Trip: reservation -><- Trip: shared ->
5759
```
5860

61+
[Top][toc]
62+
5963
### Journey Attributes
6064

6165
The `journey_attributes` array **may** have the following key value pairs:
6266

6367
- ...
6468

65-
#### Trip ID Requirements
69+
[Top][toc]
70+
71+
### Trip ID Requirements
6672

6773
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`.
6874

6975
Additionally, `trip_id` is required if `event_types` contains a `enter_jurisdiction` or `leave_jurisdiction` event pertaining to a passenger trip.
7076

77+
[Top][toc]
78+
7179
### Trip Type
7280

7381
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:
7785
- `reservation`: en route to pickup a customer who has made a reservation, with no passengers in the vehicle
7886
- `empty`: vehicle movement with no passengers (outside of other `trip_type` values) that may need to be reported, e.g. for deadheading
7987

88+
[Top][toc]
89+
8090
### Trip Attributes
8191

8292
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:
90100
- `permit_licence_number` (string, optional) - The permit licence number of the organization that dispatched the vehicle
91101
- `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.
92102

103+
[Top][toc]
104+
93105
### Fare Attributes
94106

95107
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:
108120
- `driver_trip_pay` (currency, optional) - The payment the driver received for the trip
109121
- `rate_code_id` (enumerated, optional) - one of `meter_fare`, `shared`, `out_of_town`, `disabled`, `upfront_pricing`, `promo_rate`
110122

123+
[Top][toc]
124+
111125
## Vehicle Properties
112126

113127
### Vehicle Attributes
@@ -122,14 +136,18 @@ The `vehicle_attributes` array **may** have the following key value pairs:
122136
- `placard_number` (string, optional) - the registered placard number of the vehicle
123137
- `inspection_date` (date YYYY-MM-DD, optional) - the date of the last inspection of the vehicle
124138

139+
[Top][toc]
140+
125141
### Accessibility Options
126142

127143
This `accessibility_options` enum represents the accessibility options available on a given vehicle, or the accessibility options utilized for a given trip.
128144

129-
| `accessibility_options` | Description |
145+
| `accessibility_options` | Description |
130146
|-------------------------|---------------------------------------|
131147
| `wheelchair_accessible` | This vehicle is wheelchair accessible |
132148

149+
[Top][toc]
150+
133151
## State Machine
134152

135153
### Vehicle States
@@ -228,12 +246,16 @@ This is the list of `vehicle_state` and `event_type` pairings that constitute th
228246
| `unknown` | `reserved` | `reserved` | `comms_restored` | The vehicle has come back into comms while reserved by a passenger |
229247
| `unknown` | `stopped` | `stopped` | `comms_restored` | The vehicle has come back into comms while stopped |
230248

249+
[Top][toc]
250+
231251
### State Machine Diagram
232252

233253
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.
234254

235255
![Passenger Services State Machine Diagram](passenger-services-state-machine-diagram.svg)
236256

257+
[Top][toc]
258+
237259
#### Passenger Services State Notes
238260

239261
When there is only one trip ongoing, `trip_state == vehicle_state`

0 commit comments

Comments
 (0)