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/car-share.md
+6-8Lines changed: 6 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,6 +36,8 @@ The short name identifier for Car Share used across MDS is `car-share`.
36
36
37
37
## Trip Properties
38
38
39
+
_See more available trip and fare attributes for any mode used in the [trips object](/data-types.md#trips)._
40
+
39
41
### Journey ID
40
42
41
43
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.
@@ -92,11 +94,9 @@ The `trip_attributes` array **may** have the following key value pairs:
-`app_name` (text, optional): name of the app used to reserve the trip which could be provider's app or 3rd party app
95
-
-`permit_licence_number` (string, optional) - The permit licence number of the organization that dispatched the vehicle
97
+
-`permit_license_number` (string, optional) - The permit license number of the organization that dispatched the vehicle
96
98
-`driver_id` (string, optional): Universal identifier of a specific driver, static across operators, like a driver's license number, for company employees in `reservation` or `empty` trip types, not `private` trips. Could also be used as a lookup in an agency's internal driver system.
97
99
98
-
_See more available trip attributes for any mode in the [trips endpoint](/provider#trips)._
99
-
100
100
[Top][toc]
101
101
102
102
### Fare Attributes
@@ -114,12 +114,12 @@ The `fare_attributes` array **may** have the following key value pairs:
114
114
-`taxes` (currency, optional) - amount of taxes paid for the ride
115
115
-`surcharge` (currency, optional) - any surcharge pricing
116
116
117
-
_See more available fare attributes for any mode in the [trips endpoint](/provider#trips)._
118
-
119
117
[Top][toc]
120
118
121
119
## Vehicle Properties
122
120
121
+
_See more available vehicle attributes and accessibility options for any mode used in the [vehicles object](/data-types.md#vehicles)._
122
+
123
123
### Vehicle Attributes
124
124
125
125
The `vehicle_attributes` array **may** have the following key value pairs:
@@ -137,9 +137,7 @@ The `vehicle_attributes` array **may** have the following key value pairs:
137
137
-`park_access` (boolean, optional) - access pass to a national/regional/municipal park system
138
138
-`toll_transponder` (boolean, optional) - toll transponder for national/regional toll system
139
139
-`phone_charger` (boolean, optional) - a place to charge your phone
140
-
-`sunshade` (boolean, optional) - sunshade avaialable (i.e. for windshield)
141
-
142
-
_See more available vehicle attributes for any mode in the [vehicles endpoint](/provider#vehicles)._
140
+
-`sunshade` (boolean, optional) - sunshade available (i.e. for windshield)
**Delivey Robots** refers to autonomous and remotely driven goods delivery devices. There can be one or multiple orders on different trips at the same time. The state machine tracks the trip states of the orders separately from the vehicle state.
5
+
**Delivery Robots** refers to autonomous and remotely driven goods delivery devices. There can be one or multiple orders on different trips at the same time. The state machine tracks the trip states of the orders separately from the vehicle state.
6
6
7
7
See the [modes overview](/modes) for how the mode specific information below applies across MDS.
8
8
9
9
## Robots Vs Other Delivery Types
10
10
11
-
Autonomous and remotely piloted delivery robots do not require a driver, whereas other forms of deliveries may, e.g. in a commerical or private car, truck, bike, etc. For this MDS release, this mode is limited to deliveries where a human driver is not on board the vehicle doing the delivery, and human passengers are not being transported.
11
+
Autonomous and remotely piloted delivery robots do not require a driver, whereas other forms of deliveries may, e.g. in a commercial or private car, truck, bike, etc. For this MDS release, this mode is limited to deliveries where a human driver is not on board the vehicle doing the delivery, and human passengers are not being transported.
12
12
13
13
## Table of Contents
14
14
@@ -40,6 +40,8 @@ The short name identifier for deliveries used across MDS is `delivery-robots`.
40
40
41
41
## Trip Properties
42
42
43
+
_See more available trip and fare attributes for any mode used in the [trips object](/data-types.md#trips)._
44
+
43
45
### Journey ID
44
46
45
47
The `journey_id` field shall have a consistent value in overlapping trips. Journeys may be point-to-point, multi-segment, or multi-segment overlapping.
@@ -94,16 +96,14 @@ The `trip_type` field **must** have one of the following enumerated values:
94
96
95
97
The `trip_attributes` array **may** have the following key value pairs:
96
98
97
-
-`driver_type` (ennum, required): type of driver operating the device: `human`, `semi-autonomous`, `autonomous`
98
-
-`driver_id` (UUID, optional): consistent unique identifier of the privary driver. Could be based on software version or an internal human driver id.
99
+
-`driver_type` (enum, required): type of driver operating the device: `human`, `semi-autonomous`, `autonomous`
100
+
-`driver_id` (UUID, optional): consistent unique identifier of the primary driver. Could be based on software version or an internal human driver id.
99
101
-`app_name` (text, optional): name of the app used to reserve the trip which could be provider's app or 3rd party app
100
102
-`request_time` (timestamp, optional): when the customer requested the trip
101
103
-`has_payload` (boolean, optional): is there any payload for any delivery included in the device at trip start. 1 = loaded, 0 = empty
102
-
-`range` (interger, optional): estimated range in meters based on energy levels in device at trip start
104
+
-`range` (integer, optional): estimated range in meters based on energy levels in device at trip start
103
105
-`identification_required` (boolean, optional): does the cargo require providing customer identification before trip start or upon delivery?
104
106
105
-
_See more available trip attributes for any mode in the [trips endpoint](/provider#trips)._
106
-
107
107
[Top][toc]
108
108
109
109
### Fare Attributes
@@ -113,12 +113,12 @@ The `fare_attributes` array **may** have the following key value pairs:
-`price` (currency, optional): Total price of the order
115
115
116
-
_See more available fare attributes for any mode in the [trips endpoint](/provider#trips)._
117
-
118
116
[Top][toc]
119
117
120
118
## Vehicle Properties
121
119
120
+
_See more available vehicle attributes and accessibility options for any mode used in the [vehicles object](/data-types.md#vehicles)._
121
+
122
122
### Vehicle Attributes
123
123
124
124
The `vehicle_attributes` array **may** have the following key value pairs:
@@ -138,8 +138,6 @@ The `vehicle_attributes` array **may** have the following key value pairs:
138
138
-`top_speed` (integer, optional): theoretical top speed in meters per second of the device
139
139
-`storage_capacity` (integer, optional): cubic centimeters of cargo space available not including any cargo
140
140
141
-
_See more available vehicle attributes for any mode in the [vehicles endpoint](/provider#vehicles)._
142
-
143
141
[Top][toc]
144
142
145
143
### Accessibility Options
@@ -289,7 +287,7 @@ When there is only one trip ongoing, `trip_state == vehicle_state`
289
287
290
288
In cases where there are multiple trips ongoing, please follow the trip state model pseudocode for determining what the vehicle state should be:
291
289
```
292
-
t = for the one vehicle, all on-going trips which are 'delivey' or undefined trips (we do not take into account 'roaming', 'return' or 'advertising' trips)
290
+
t = for the one vehicle, all on-going trips which are 'delivery' or undefined trips (we do not take into account 'roaming', 'return' or 'advertising' trips)
Copy file name to clipboardExpand all lines: modes/passenger-services.md
+4-6Lines changed: 4 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,6 +40,8 @@ The short name identifier for Passenger Services used across MDS is `passenger-s
40
40
41
41
## Trip Properties
42
42
43
+
_See more available trip and fare attributes for any mode used in the [trips object](/data-types.md#trips)._
44
+
43
45
### Journey ID
44
46
45
47
The `journey_id` field shall have a consistent value in overlapping trips, e.g. "pooled" or "shared" rides with different start and/or end locations. Journeys may be point-to-point, multi-segment, or multi-segment overlapping.
@@ -107,8 +109,6 @@ The `trip_attributes` array **may** have the following key value pairs:
107
109
-`wheelchair_transported` (boolean, optional) - was a wheelchair transported as part of this trip?
108
110
-`cancellation_reason` (String, Conditionally Required): The reason why a *driver* cancelled a reservation. (required if a driver cancelled a trip, and a `driver_cancellation` event_type was part of the trip)
109
111
110
-
_See more available trip attributes for any mode in the [trips endpoint](/provider#trips)._
111
-
112
112
[Top][toc]
113
113
114
114
### Fare Attributes
@@ -130,12 +130,12 @@ The `fare_attributes` array **may** have the following key value pairs:
130
130
-`driver_trip_pay` (currency, optional) - The payment the driver received for the trip
131
131
-`rate_code_id` (enumerated, optional) - one of `meter_fare`, `shared`, `out_of_town`, `disabled`, `upfront_pricing`, `promo_rate`
132
132
133
-
_See more available fare attributes for any mode in the [trips endpoint](/provider#trips)._
134
-
135
133
[Top][toc]
136
134
137
135
## Vehicle Properties
138
136
137
+
_See more available vehicle attributes and accessibility options for any mode used in the [vehicles object](/data-types.md#vehicles)._
138
+
139
139
### Vehicle Attributes
140
140
141
141
The `vehicle_attributes` array **may** have the following key value pairs:
@@ -149,8 +149,6 @@ The `vehicle_attributes` array **may** have the following key value pairs:
149
149
-`license_plate` (string, optional) - the registered vehicle license/number/registration plate identifier on the vehicle
150
150
-`inspection_date` (date YYYY-MM-DD, optional) - the date of the last inspection of the vehicle
151
151
152
-
_See more available vehicle attributes for any mode in the [vehicles endpoint](/provider#vehicles)._
0 commit comments