Skip to content

Commit 8175ba0

Browse files
committed
move Vehicle up to gen-info
1 parent c8fd879 commit 8175ba0

3 files changed

Lines changed: 22 additions & 31 deletions

File tree

agency/README.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -75,20 +75,6 @@ If `device_id` is specified, `GET` will return an array with a single vehicle re
7575
}
7676
```
7777

78-
A vehicle record is as follows:
79-
80-
| Field | Type | Field Description |
81-
| ------------- | --------- | ----------------------------------------------------------------------------- |
82-
| `device_id` | UUID | Provided by Operator to uniquely identify a vehicle |
83-
| `provider_id` | UUID | Issued by Agency and [tracked](../providers.csv) |
84-
| `vehicle_id` | String | Vehicle Identification Number (vehicle_id) visible on vehicle |
85-
| `vehicle_type` | Enum | [Vehicle Type][vehicle-types] |
86-
| `propulsion_types` | Enum[] | Array of [Propulsion Type][propulsion-types]; allows multiple values |
87-
| `vehicle_attributes` | Array of [vehicle attributes](/modes/#vehicle-attributes) | Vehicle attributes appropriate for the current [mode][modes] |
88-
| `state` | Enum | Current vehicle state. See [Vehicle State][vehicle-states] |
89-
| `prev_events` | Enum[] | Last [Vehicle Event][vehicle-events] |
90-
| `updated` | [timestamp][ts] | Date of last event update |
91-
9278
404 Failure Response:
9379

9480
_No content returned on vehicle not found._

general-information.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ This document contains specifications that are shared between the various MDS [A
2222
- [GBFS Compatibility](#gbfs-compatibility)
2323
- [Timestamps](#timestamps)
2424
- [UUIDs](#uuids)
25+
- [Vehicles](#vehicles)
2526
- [Vehicle Characteristics](#vehicle-characteristics)
2627
- [Accessibility Options](#accessibility-options)
2728
- [Propulsion Types](#propulsion-types)
@@ -386,6 +387,24 @@ See new location within [individual modes](/modes#list-of-supported-modes) in [m
386387

387388
[Top][toc]
388389

390+
## Vehicles
391+
392+
A vehicle record is as follows:
393+
394+
| Field | Type | Field Description |
395+
| ------------- | --------- | ----------------------------------------------------------------------------- |
396+
| `device_id` | UUID | Provided by Operator to uniquely identify a vehicle |
397+
| `provider_id` | UUID | Issued by Agency and [tracked](../providers.csv) |
398+
| `vehicle_id` | String | Vehicle Identification Number (vehicle_id) visible on vehicle |
399+
| `vehicle_type` | Enum | [Vehicle Type][vehicle-types] |
400+
| `propulsion_types` | Enum[] | Array of [Propulsion Type][propulsion-types]; allows multiple values |
401+
| `vehicle_attributes` | Array of [vehicle attributes](/modes/#vehicle-attributes) | Vehicle attributes appropriate for the current [mode][modes] |
402+
| `state` | Enum | Current vehicle state. See [Vehicle State][vehicle-states] |
403+
| `prev_events` | Enum[] | Last [Vehicle Event][vehicle-events] |
404+
| `updated` | [timestamp][ts] | Date of last event update |
405+
406+
[Top][toc]
407+
389408
## Vehicle Characteristics
390409

391410
Properties and characteristics of vehicles and devices.

provider/README.md

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ This specification contains a data standard for *mobility as a service* provider
2424
* [Events - Query Parameters](#events---query-parameters)
2525
* [Telemetry][telemetry]
2626
* [Telemetry - Query Parameters](#telemetry---query-parameters)
27+
* [Vehicles][vehicles]
2728
* [Reports](#reports)
2829
* [Reports - Response](#reports---response)
2930
* [Reports - Example](#reports---example)
@@ -544,23 +545,7 @@ In addition to the standard [Provider payload wrapper](#response-format), respon
544545
**Method:** `GET`
545546
**[Beta feature][beta]:** No (as of 1.2.0)
546547
**Schema:** [`vehicles` schema][vehicles-schema]
547-
**`data` Payload:** `{ "vehicles": [] }`, an array of objects with the following structure
548-
549-
| Field | Type | Required/Optional | Comments |
550-
| ----- | ---- | ----------------- | ----- |
551-
| `provider_id` | UUID | Required | A UUID for the Provider, unique within MDS. See MDS [provider list](/providers.csv). |
552-
| `provider_name` | String | Required | The public-facing name of the Provider |
553-
| `device_id` | UUID | Required | A unique device ID in UUID format, should match this device in Provider |
554-
| `vehicle_id` | String | Required | A unique vehicle identifier (visible code, licence plate, etc), visible on the vehicle itself |
555-
| `vehicle_type` | Enum | Required | see [vehicle types][vehicle-types] table |
556-
| `vehicle_attributes` | Array | Optional | **[Mode](/modes#list-of-supported-modes) Specific**. [Vehicle attributes](/modes#vehicle-attributes) given as mode-specific unordered key-value pairs |
557-
| `propulsion_types` | Enum[] | Required | Array of [propulsion types][propulsion-types]; allows multiple values |
558-
| `last_event_time` | [timestamp][ts] | Required | Date/time when last state change occurred. See [Event Times][event-times] |
559-
| `last_vehicle_state` | Enum | Required | [Vehicle state][vehicle-states] of most recent state change. |
560-
| `last_event_types` | Enum[] | Required | [Vehicle event(s)][vehicle-events] of most recent state change, allowable values determined by `last_vehicle_state`. |
561-
| `last_event_location` | GeoJSON [Point Feature][point-geo]| Required | Location of vehicle's last event. See also [Stop-based Geographic Data][stop-based-geo]. |
562-
| `current_location` | GeoJSON [Point Feature][point-geo] | 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]. |
563-
| `battery_pct` | Float | Required if Applicable | Percent battery charge of device, expressed between 0 and 1 |
548+
**`data` Payload:** `{ "vehicles": [] }`, an array of [Vehicle](vehicle) objects
564549

565550
(?) Open question: should we standardize on telemetry over GeoJSON Point? E.g. replace last_event_location with last_event_telemetry.
566551

@@ -601,6 +586,7 @@ In addition to the standard [Provider payload wrapper](#response-format), respon
601586
[trips-schema]: trips.json
602587
[ts]: /general-information.md#timestamps
603588
[vehicles]: #vehicles
589+
[vehicle]: /general-information.md#vehicles
604590
[vehicle-types]: /general-information.md#vehicle-types
605591
[vehicle-states]: /modes#vehicle-states
606592
[vehicle-events]: /modes#event-types

0 commit comments

Comments
 (0)