Skip to content

Commit 05b058f

Browse files
Update data-types.md
Added service id and GTFS integration for to events, trips, and telemetry. Added stop_sequence to Telemetry. Signed-off-by: Matthew Marwedel <105882144+matthewmarwedel@users.noreply.github.com>
1 parent 7d1d14e commit 05b058f

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

data-types.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,8 @@ Events represent changes in vehicle status.
115115
| `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` |
116116
| `associated_ticket` | String | Optional | Identifier for an associated ticket inside an Agency-maintained 311 or CRM system |
117117
| `stop_sequence` | Integer | Required if Applicable | Order of stops for a particular trip. The values must increase along the trip, but do not need to be consecutive. |
118-
| `route_id` | UUID | Required if Applicable | A unique route ID for the associated route and stops |
118+
| `route_id` | UUID | Required if Applicable | A unique route ID for the associated route and stops. Matches [GTFS](https://gtfs.org/documentation/schedule/reference/) `route_id` |
119+
| `service_id` | UUID | Required if Applicable | A unique service ID for the set of dates when service is available for a route. Matches [GTFS](https://gtfs.org/documentation/schedule/reference/) `service_id` |
119120

120121
### Event Times
121122

@@ -142,7 +143,9 @@ A standard point of vehicle telemetry. References to latitude and longitude impl
142143
| `battery_percent` | Integer | Required if Applicable | Percent battery charge of vehicle, expressed between 0 and 100 |
143144
| `fuel_percent` | Integer | Required if Applicable | Percent fuel in vehicle, expressed between 0 and 100 |
144145
| `tipped_over` | Boolean | Required if Known | If detectable and known, is the device tipped over or not? Default is 'false'. |
145-
| `route_id` | UUID | Required if Applicable | A unique route ID for the associated route and stops |
146+
| `stop_sequence` | Integer | Required if Applicable | Order of stops for a particular trip. The values must increase along the trip, but do not need to be consecutive. |
147+
| `route_id` | UUID | Required if Applicable | A unique route ID for the associated route and stops. Matches [GTFS](https://gtfs.org/documentation/schedule/reference/) `route_id` |
148+
| `service_id` | UUID | Required if Applicable | A unique service ID for the set of dates when service is available for a route. Matches [GTFS](https://gtfs.org/documentation/schedule/reference/) `service_id` |
146149

147150
### GPS Data
148151

@@ -241,7 +244,8 @@ A Trip is defined by the following structure:
241244
| `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]) |
242245
| `currency` | String | Optional, USD cents is implied if null.| An [ISO 4217 Alphabetic Currency Code][iso4217] representing the currency of the payee (see [Costs & Currencies][costs-and-currencies]) |
243246
| `stop_sequence` | Integer | Required if Applicable | Order of stops for a particular trip. The values must increase along the trip, but do not need to be consecutive. |
244-
| `route_id` | UUID | Required if Applicable | A unique route ID for the associated route and stops |
247+
| `route_id` | UUID | Required if Applicable | A unique route ID for the associated route and stops. Matches [GTFS](https://gtfs.org/documentation/schedule/reference/) `route_id` |
248+
| `service_id` | UUID | Required if Applicable | A unique service ID for the set of dates when service is available for a route. Matches [GTFS](https://gtfs.org/documentation/schedule/reference/) `service_id` |
245249

246250
[Top][toc]
247251

0 commit comments

Comments
 (0)