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: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -82,7 +82,7 @@ You can read more in our **[Understanding the different MDS APIs](https://github
82
82
83
83
## GBFS Requirement
84
84
85
-
All MDS compatible Provider and/or Agency feeds [must also expose](/provider/README.md#gbfs) a public [GBFS](https://github.com/NABSA/gbfs) feed for the micromobility and car share [modes](/modes) (passenger services and delivery robots may be optionally supported at the discretion of the agency running the program). Compatibility with [GBFS 2.2](https://github.com/NABSA/gbfs/blob/v2.2/gbfs.md) or greater is advised, or the version recommended per MobilityData's [supported releases](https://github.com/MobilityData/gbfs#past-version-releases) guidance. See our [MDS Vehicles Guide](https://github.com/openmobilityfoundation/mobility-data-specification/wiki/MDS-Vehicles) for how MDS Provider/Agency `/devices` can be used by regulators instead of the public GBFS `/free_bike_status`. Additional information on MDS and GBFS can be found in this [guidance document](https://github.com/openmobilityfoundation/governance/blob/main/technical/GBFS_and_MDS.md).
85
+
All MDS compatible Provider and/or Agency feeds must also expose a public [GBFS](https://github.com/NABSA/gbfs) feed for the micromobility and car share [modes](/modes) (passenger services and delivery robots may be optionally supported at the discretion of the agency running the program). Compatibility with [GBFS 2.2](https://github.com/NABSA/gbfs/blob/v2.2/gbfs.md) or greater is advised, or the version recommended per MobilityData's [supported releases](https://github.com/MobilityData/gbfs#past-version-releases) guidance. See our [MDS Vehicles Guide](https://github.com/openmobilityfoundation/mobility-data-specification/wiki/MDS-Vehicles) for how MDS Provider/Agency `/vehicles` can be used by regulators instead of the public GBFS `/free_bike_status`. Additional information on MDS and GBFS can be found in this [guidance document](https://github.com/openmobilityfoundation/governance/blob/main/technical/GBFS_and_MDS.md).
Copy file name to clipboardExpand all lines: data-types.md
+20-23Lines changed: 20 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
# Mobility Data Specification: **Data Types**
2
2
3
3
-[Vehicles](#vehicles)
4
-
-[Propulsion Types](#propulsion-types)
5
4
-[Vehicle Types](#vehicle-types)
5
+
-[Propulsion Types](#propulsion-types)
6
6
-[Vehicle Status](#vehicle-status)
7
7
-[Events](#events)
8
8
-[Event Types](#event-times)
@@ -23,27 +23,14 @@ A vehicle record is as follows:
23
23
|`data_provider_id`| UUID | Optional | If different than `provider_id`, a UUID for the data solution provider managing the data feed in this endpoint. See MDS [provider list](/providers.csv) which includes both service operators and data solution providers. |
24
24
|`vehicle_id`| String | Required | A unique vehicle identifier (visible code, license plate, etc), visible on the vehicle itself |
25
25
|`vehicle_type`| Enum | Required | The [vehicle type][vehicle-types]|
26
-
|`vehicle_attributes`| Array | Optional |**[Mode][modes]-Specific**[vehicle attributes](/modes#vehicle-attributes) given as mode-specific unordered key-value pairs |
26
+
|`vehicle_attributes`| Array | Optional |**[Mode](/modes#list-of-supported-modes)Specific**. [Vehicle attributes](/modes#vehicle-attributes) given as mode-specific unordered key-value pairs |
|`accessability_options`| Enum[]| Required |Array of mode-specific [accessability options][accessability-options]|
28
+
|`accessibility_options`| Enum[]| Required |**[Mode](/modes#list-of-supported-modes) Specific**. [Accessibility options](/modes#accessibility-options) given as an array of enumerated values.|
29
29
|`battery_capacity`| Integer | Required if Available | Capacity of battery expressed as milliamp hours (mAh) |
30
30
|`fuel_capacity`| Integer | Required if Available | Capacity of fuel tank (liquid, solid, gaseous) expressed in liters |
|`electric_assist`| Provides power only alongside human propulsion |
40
-
|`electric`| Contains throttle mode with a battery-powered motor |
41
-
|`combustion`| Contains throttle mode with a gas engine-powered motor |
42
-
43
-
A vehicle may have one or more values from the `propulsion`, depending on the number of modes of operation. For example, a scooter that can be powered by foot or by electric motor would have the `propulsion` represented by the array `['human', 'electric']`. A bicycle with pedal-assist would have the `propulsion` represented by the array `['human', 'electric_assist']` if it can also be operated as a traditional bicycle.
44
-
45
-
[Top][toc]
46
-
47
34
### Vehicle Types
48
35
49
36
The list of allowed `vehicle_type` values in MDS. Aligning with [GBFS vehicle types form factors](https://github.com/NABSA/gbfs/blob/master/gbfs.md#vehicle_typesjson-added-in-v21-rc).
@@ -60,6 +47,19 @@ The list of allowed `vehicle_type` values in MDS. Aligning with [GBFS vehicle ty
|`electric_assist`| Provides power only alongside human propulsion |
56
+
|`electric`| Contains throttle mode with a battery-powered motor |
57
+
|`combustion`| Contains throttle mode with a gas engine-powered motor |
58
+
59
+
A vehicle may have one or more values from the `propulsion`, depending on the number of modes of operation. For example, a scooter that can be powered by foot or by electric motor would have the `propulsion` represented by the array `['human', 'electric']`. A bicycle with pedal-assist would have the `propulsion` represented by the array `['human', 'electric_assist']` if it can also be operated as a traditional bicycle.
60
+
61
+
[Top][toc]
62
+
63
63
## Vehicle Status
64
64
65
65
A vehicle status record represents the current or last-known event and telemetry from a vehicle, defined as follows:
@@ -195,15 +195,12 @@ A Trip is defined by the following structure:
195
195
| Field | Type | Required/Optional | Comments |
196
196
| ----- | ---- | ----------------- | -------- |
197
197
|`provider_id`| UUID | Required | A UUID for the Provider, unique within MDS. See MDS [provider list](/providers.csv). |
198
-
|`provider_name`| String | Required | The public-facing name of the Provider |
199
198
|`data_provider_id`| UUID | Optional | If different than `provider_id`, a UUID for the data solution provider managing this data endpoint. See MDS [provider list](/providers.csv) which includes both service operators and data solution providers. |
200
-
|`device_id`| UUID | Required | A unique device ID in UUID format |
201
-
|`vehicle_id`| String | Required | The Vehicle Identification Number visible on the vehicle itself |
202
-
|`vehicle_type`| Enum | Required | See [vehicle types][vehicle-types] table |
|`device_id`| UUID | Required | A unique device ID in UUID format. Cross reference with `/vehicles` for more device details. |
204
200
|`journey_id`| UUID | Optional | A unique [journey ID](/modes#journey-id) for associating collections of trips for its [mode][modes]|
205
-
|`trip_type`| Enum| Optional |**[Mode](/modes#list-of-supported-modes) Specific**. The [trip type](/modes#trip-type) describing the purpose of a trip segment|
201
+
|`journey_attributes`| Map| Optional |**[Mode](/modes#list-of-supported-modes) Specific**. [Journey attributes](/modes#journey-attributes) given as unordered key-value pairs|
206
202
|`trip_id`| UUID | Required | A unique ID for each trip |
203
+
|`trip_type`| Enum | Optional |**[Mode](/modes#list-of-supported-modes) Specific**. The [trip type](/modes#trip-type) describing the purpose of a trip segment |
207
204
|`trip_attributes`| Map | Optional |**[Mode](/modes#list-of-supported-modes) Specific**. [Trip attributes](/modes#trip-attributes) given as unordered key-value pairs |
208
205
|`fare_attributes`| Map | Optional |**[Mode](/modes#list-of-supported-modes) Specific**. [Fare attributes](/modes#fare-attributes) given as unordered key-value pairs |
209
206
|`start_time`|[Timestamp][ts]| Required | Start of the passenger/driver trip |
@@ -213,7 +210,6 @@ A Trip is defined by the following structure:
213
210
|`duration`| Integer | Required | Time, in Seconds |
214
211
|`distance`| Integer | Required | Trip Distance, in Meters |
215
212
|`publication_time`|[Timestamp][ts]| Optional | Date/time that trip became available through the trips endpoint |
216
-
|`accessibility_options`| Enum[]| Optional |**[Mode](/modes#list-of-supported-modes) Specific**. [Accessibility options](/modes#accessibility-options) given as an array of enumerated values. The **union** of any accessibility options requested, and used. E.g. if the passenger requests a vehicle with `wheelchair_accessible`, but doesn’t utilize the features during the trip, the trip payload will include `accessibility_options: ['wheelchair_accessible']`. |
217
213
|`parking_verification_url`| URL | Optional | A URL to a photo (or other evidence) of proper vehicle parking |
218
214
|`standard_cost`| Integer | Optional | The cost, in the currency defined in `currency`, to perform that trip in the standard operation of the System (see [Costs & Currencies][costs-and-currencies]) |
219
215
|`actual_cost`| Integer | Optional | The actual cost, in the currency defined in `currency`, paid by the customer of the *mobility as a service* provider (see [Costs & Currencies][costs-and-currencies]) |
@@ -232,6 +228,7 @@ A Trip is defined by the following structure:
0 commit comments