Skip to content

Commit 7d1d14e

Browse files
Update data-types.md for new commuter shuttle fields
adding route_id field to [Events, Trips, Telemetry] adding stop_sequence field to [Events, Trips] Signed-off-by: Matthew Marwedel <105882144+matthewmarwedel@users.noreply.github.com>
1 parent 2adc8f7 commit 7d1d14e

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

data-types.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,8 @@ Events represent changes in vehicle status.
114114
| `fuel_percent` | Integer | Required if Applicable | Percent fuel in vehicle, expressed between 0 and 100 |
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 |
117+
| `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 |
117119

118120
### Event Times
119121

@@ -140,6 +142,7 @@ A standard point of vehicle telemetry. References to latitude and longitude impl
140142
| `battery_percent` | Integer | Required if Applicable | Percent battery charge of vehicle, expressed between 0 and 100 |
141143
| `fuel_percent` | Integer | Required if Applicable | Percent fuel in vehicle, expressed between 0 and 100 |
142144
| `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 |
143146

144147
### GPS Data
145148

@@ -237,6 +240,8 @@ A Trip is defined by the following structure:
237240
| `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]) |
238241
| `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]) |
239242
| `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]) |
243+
| `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 |
240245

241246
[Top][toc]
242247

0 commit comments

Comments
 (0)