Skip to content

Commit 9530e1e

Browse files
committed
simplify vehicle status to be just last event + last telemetry
1 parent 345f145 commit 9530e1e

1 file changed

Lines changed: 5 additions & 11 deletions

File tree

data-types.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ A vehicle record is as follows:
2525
| `device_id` | UUID | Required | A unique device ID in UUID format, should match this device in Provider |
2626
| `provider_id` | UUID | Required | A UUID for the Provider, unique within MDS. See MDS [provider list](/providers.csv). |
2727
| `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. |
28-
| `vehicle_id` | String | Required | A unique vehicle identifier (visible code, license plate, etc), visible on the vehicle itself |
2928
| `vehicle_type` | Enum | Required | The [vehicle type][vehicle-types] |
3029
| `vehicle_attributes` | Array | Optional | **[Mode][modes]-Specific** [vehicle attributes](/modes#vehicle-attributes) given as mode-specific unordered key-value pairs |
3130
| `propulsion_types` | Enum[] | Required | Array of [propulsion types][propulsion-types]; allows multiple values |
@@ -70,18 +69,15 @@ The list of allowed `vehicle_type` values in MDS. Aligning with [GBFS vehicle ty
7069

7170
## Vehicle Status
7271

73-
A vehicle status record represents the current or last-known disposition of a vehicle, defined as follows:
72+
A vehicle status record represents the current or last-known event and telemetry from a vehicle, defined as follows:
7473

7574
| Field | Type | Required/Optional | Comments |
76-
| ----- | ---- | ----------------- | ----- |
75+
| ----- | ---- | ----------------- | -------- |
7776
| `device_id` | UUID | Required | A unique device ID in UUID format, should match this device in Provider |
7877
| `provider_id` | UUID | Required | A UUID for the Provider, unique within MDS. See MDS [provider list](/providers.csv). |
7978
| `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. |
80-
| `last_vehicle_state` | Enum | Required | [Vehicle state][vehicle-states] of most recent state change. |
81-
| `last_event_time` | [Timestamp][ts] | Required | Date/time when last state change occurred. See [Event Times][event-times] |
82-
| `last_event_types` | Enum[] | Required | [Vehicle event(s)][vehicle-events] of most recent state change, allowable values determined by `last_vehicle_state`. |
83-
| `last_event_location` | [GPS][gps]| Required | Location of vehicle's last event. See also [Stop-based Geographic Data][stop-based-geo]. |
84-
| `current_location` | [GPS][gps] | Required if Applicable | Current location of vehicle if different from last event, and the vehicle is not currently on a trip. See also [Stop-based Geographic Data][stop-based-geo]. |
79+
| `last_event` | Event | Required | Most recent [Event](#events) based on `timestamp` |
80+
| `last_telemetry` | Telemetry | Required | Most recent [Telemetry](#telemetry) based on `timestamp` |
8581

8682
[Top][toc]
8783

@@ -98,7 +94,7 @@ Events represent changes in vehicle status.
9894
| `vehicle_id` | String | Required | A unique vehicle identifier (visible code, license plate, etc), visible on the vehicle itself |
9995
| `vehicle_state` | Enum | Required | See [vehicle state][vehicle-states] table |
10096
| `event_types` | Enum[] | Required | Vehicle [event types][vehicle-events] for state change, with allowable values determined by `vehicle_state` |
101-
| `event_time` | [Timestamp][ts] | Required | Date/time that event occurred at. See [Event Times][event-times] |
97+
| `timestamp` | [Timestamp][ts] | Required | Date/time that event occurred at. See [Event Times][event-times] |
10298
| `publication_time` | [Timestamp][ts] | Optional | Date/time that event became available through the status changes endpoint |
10399
| `event_location` | [GPS][gps] | Required | See also [Stop-based Geographic Data][stop-based-geo]. |
104100
| `event_geographies` | UUID[] | Optional | **[Beta feature](/general-information.md#beta-features):** *Yes (as of 2.0.0)*. Array of Geography UUIDs consisting of every Geography that contains the location of the status change. See [Geography Driven Events][geography-driven-events]. Required if `event_location` is not present. |
@@ -242,8 +238,6 @@ Examples of mode-specific `trip_attributes`:
242238
| `accessibility_options` | Enum[] | Optional | 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']`. See [accessibility-options][accessibility-options] |
243239
| `parking_verification_url` | String | Optional | A URL to a photo (or other evidence) of proper vehicle parking |
244240

245-
(?) Do I have the right partitioning between trip attributes and reservation attributes?
246-
247241
[Top][toc]
248242

249243
[agency]: /agency/README.md

0 commit comments

Comments
 (0)