Skip to content

Commit 7d6f7ec

Browse files
committed
add telemetry_id and trip_ids and journey_id to telemetry
1 parent c7dee62 commit 7d6f7ec

1 file changed

Lines changed: 13 additions & 8 deletions

File tree

general-information.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -319,14 +319,15 @@ Events represent changes in vehicle status.
319319
| `publication_time` | [timestamp][ts] | Optional | Date/time that event became available through the status changes endpoint |
320320
| `event_location` | GeoJSON [Point Feature][point-geo] | Required | See also [Stop-based Geographic Data][stop-based-geo]. |
321321
| `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. |
322-
| `trip_id` | UUID | Required if Applicable | Trip UUID (foreign key to /trips endpoint), required if `event_types` contains `trip_start`, `trip_end`, `trip_cancel`, `trip_enter_jurisdiction`, or `trip_leave_jurisdiction` |
322+
| `trip_ids`[] | UUID[] | Required if Applicable | Trip UUIDs (foreign key to /trips endpoint), required if `event_types` contains `trip_start`, `trip_end`, `trip_cancel`, `trip_enter_jurisdiction`, or `trip_leave_jurisdiction` |
323+
| `journey_id` | UUID | Optional | Journey UUID | TODO "see `journey_id`" or something |
323324
| `associated_ticket` | String | Optional | Identifier for an associated ticket inside an Agency-maintained 311 or CRM system |
324325

325-
(?) Use Telemetry instead of Point?
326-
327326
(?) Do we still want `event_geographies`?
328327

329-
(?) Add `journey_id`(s)?
328+
(?) Replace `event_location` GeoJSON with Telemetry
329+
330+
(?) Does anyone use `associated_ticket`?
330331

331332
### Event Times
332333

@@ -338,13 +339,13 @@ Because of the unreliability of device clocks, the Provider is unlikely to know
338339

339340
A standard point of vehicle telemetry. References to latitude and longitude imply coordinates encoded in the [WGS 84 (EPSG:4326)](https://en.wikipedia.org/wiki/World_Geodetic_System) standard GPS or GNSS projection expressed as [Decimal Degrees](https://en.wikipedia.org/wiki/Decimal_degrees).
340341

341-
(?) Add `journey_id`?
342-
343342
| Field | Type | Required/Optional | Field Description |
344343
| -------------- | -------------- | --------------------- | ------------------------------------------------------------ |
344+
| `telemetry_id` | UUID | Required | ID used for uniquely-identifying a Telemetry entry |
345345
| `device_id` | UUID | Required | ID used in [Register](#vehicle---register) |
346346
| `timestamp` | [timestamp][ts]| Required | Date/time that event occurred. Based on GPS or GNSS clock |
347-
| `trip_id` | UUID | Required | If telemetry occurred during a trip, the ID of the trip. If not in a trip, `null`.
347+
| `trip_ids` | UUID[] | Required | If telemetry occurred during a trip, the ID of the trip(s). If not in a trip, `null`.
348+
| `journey_id` | UUID | Required | If telemetry occurred during a trip, the ID of the journey. If not in a trip, `null`.
348349
| `stop_id` | UUID | Required if Applicable | Stop that the vehicle is currently located at. Only applicable for _docked_ Micromobility. See [Stops][stops] |
349350
| `gps` | Object | Required | Telemetry position data |
350351
| `gps.lat` | Double | Required | Latitude of the location |
@@ -358,6 +359,8 @@ A standard point of vehicle telemetry. References to latitude and longitude impl
358359
| `battery_percent` | Integer | Required if Applicable | Percent battery charge of vehicle, expressed between 0 and 100 |
359360
| `fuel_percent` | Integer | Required if Applicable | Percent fuel in vehicle, expressed between 0 and 100 |
360361

362+
(?) Add `journey_id`?
363+
361364
[Top][toc]
362365

363366
## Stops
@@ -467,7 +470,7 @@ A vehicle record is as follows:
467470
| `provider_id` | UUID | Required | A UUID for the Provider, unique within MDS. See MDS [provider list](/providers.csv). |
468471
| `device_id` | UUID | Required | A unique device ID in UUID format, should match this device in Provider |
469472
| `vehicle_id` | String | Required | A unique vehicle identifier (visible code, licence plate, etc), visible on the vehicle itself |
470-
| `vehicle_type` | Enum | Required | see [vehicle types][vehicle-types] table |
473+
| `vehicle_type` | Enum | Required | see [vehicle types][#vehicle-types] (?) FIXME table |
471474
| `vehicle_attributes` | Array | Optional | **[Mode](/modes#list-of-supported-modes) Specific**. [Vehicle attributes](/modes#vehicle-attributes) given as mode-specific unordered key-value pairs |
472475
| `propulsion_types` | Enum[] | Required | Array of [propulsion types][propulsion-types]; allows multiple values |
473476
| `battery_capacity` | Integer | Required if Available | Capacity of battery expressed as milliamp hours (mAh) |
@@ -478,6 +481,8 @@ A vehicle record is as follows:
478481
| `last_event_location` | GeoJSON [Point Feature][point-geo]| Required | Location of vehicle's last event. See also [Stop-based Geographic Data][stop-based-geo]. |
479482
| `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]. |
480483

484+
(?) Remove GeoJSON Point
485+
481486
[Top][toc]
482487

483488
## Vehicle Characteristics

0 commit comments

Comments
 (0)