Skip to content

Commit e934268

Browse files
committed
move _percent fields into telemetry. correct some copy-paste errors.
1 parent e4367d0 commit e934268

2 files changed

Lines changed: 13 additions & 12 deletions

File tree

agency/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ _No content returned on vehicle not found._
8383

8484
## Vehicle - Register
8585

86-
The `/vehicles` registration endpoint is used to register a vehicle for use in the Agency jurisdiction.
86+
The `/vehicles` registration endpoint is used to register a vehicle for use in the Agency's jurisdiction.
8787

8888
Endpoint: `/vehicles`
8989
Method: `POST`
@@ -170,7 +170,7 @@ Body Params:
170170
| ---------- | ------------------------------ | ------------------------------------------------------------------------------------------------------- |
171171
| `success` | Integer | Number of successfully written events. |
172172
| `total` | Integer | Total number of provided events. |
173-
| `failures` | [Event](#vehicle-event-data)[] | Array of invalid events (empty if all successful). |
173+
| `failures` | [EventData](#vehicle-event-data)[] | Array of invalid events (empty if all successful). |
174174

175175
(?) Should we have a description/error-code for each failure in the `failures`?
176176

@@ -294,22 +294,22 @@ The Trips endpoint serves two purposes:
294294

295295
**Endpoint:** `/trips`
296296
**Method:** `POST`
297-
**[Beta feature][beta]:** Yes (as of 2.0.0)
297+
**[Beta feature][beta]:** No (as of 2.0.0)
298298
**Payload:** `{ "trips": [] }`, an array of [Trips](#trip-data)
299299

300300
Body Params:
301301

302302
| Field | Type | Required/Optional | Field Description |
303303
| ------------- | ------------------------------ | ----------------- | -------------------------------------------------------------------------------------- |
304-
| `trips` | [Trip](#trip-data)[] | Required | Array of trips for one or more vehicles. |
304+
| `trips` | [Trip](#trip-data)[] | Required | Array of trip records
305305

306306
200 Success Response:
307307

308308
| Field | Type | Field Description |
309309
| ---------- | ------------------------------ | ------------------------------------------------------------------------------------------------------- |
310-
| `success` | Integer | Number of successfully written telemetry data points. |
311-
| `total` | Integer | Total number of provided points. |
312-
| `failures` | [Telemetry](#telemetry-data)[] | Array of failed telemetry for zero or more vehicles (empty if all successful). |
310+
| `success` | Integer | Number of successfully written trip records points |
311+
| `total` | Integer | Total number of provided points |
312+
| `failures` | [Trip](#trip-data)[] | Array of failed trip records (empty if all successful) |
313313

314314

315315
400 Failure Response:

general-information.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ References to geographic datatypes (Point, MultiPolygon, etc.) imply coordinates
8181

8282
Whenever a vehicle location coordinate measurement is presented, it must be represented as a GeoJSON [`Feature`][geojson-feature] object with a corresponding `properties` object with the following properties:
8383

84+
(?) Reconcile with Telemetry description, below
8485

8586
| Field | Type | Required/Optional | Field Description |
8687
| -------------- | --------------- | --------------------- | ------------------------------------------------------------ |
@@ -337,11 +338,14 @@ Because of the unreliability of device clocks, the Provider is unlikely to know
337338

338339
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).
339340

341+
(?) Add `journey_id`?
342+
340343
| Field | Type | Required/Optional | Field Description |
341344
| -------------- | -------------- | --------------------- | ------------------------------------------------------------ |
342345
| `device_id` | UUID | Required | ID used in [Register](#vehicle---register) |
343346
| `timestamp` | [timestamp][ts]| Required | Date/time that event occurred. Based on GPS or GNSS clock |
344347
| `trip_id` | UUID | Required | If telemetry occurred during a trip, the ID of the trip. If not in a trip, `null`.
348+
| `stop_id` | UUID | Required if Applicable | Stop that the vehicle is currently located at. Only applicable for _docked_ Micromobility. See [Stops][stops] |
345349
| `gps` | Object | Required | Telemetry position data |
346350
| `gps.lat` | Double | Required | Latitude of the location |
347351
| `gps.lng` | Double | Required | Longitude of the location |
@@ -351,8 +355,8 @@ A standard point of vehicle telemetry. References to latitude and longitude impl
351355
| `gps.accuracy` | Float | Required if Available | Horizontal accuracy, in meters |
352356
| `gps.hdop` | Float | Required if Available | Horizontal GPS or GNSS accuracy value (see [hdop][hdop]) |
353357
| `gps.satellites` | Integer | Required if Available | Number of GPS or GNSS satellites
354-
| `charge` | Float | Required if Applicable | Percent battery charge of vehicle, expressed between 0 and 1 |
355-
| `stop_id` | UUID | Required if Applicable | Stop that the vehicle is currently located at. Only applicable for _docked_ Micromobility. See [Stops][stops] |
358+
| `battery_percent` | Integer | Required if Applicable | Percent battery charge of vehicle, expressed between 0 and 100 |
359+
| `fuel_percent` | Integer | Required if Applicable | Percent fuel in vehicle, expressed between 0 and 100 |
356360

357361
[Top][toc]
358362

@@ -473,9 +477,6 @@ A vehicle record is as follows:
473477
| `last_event_types` | Enum[] | Required | [Vehicle event(s)][vehicle-events] of most recent state change, allowable values determined by `last_vehicle_state`. |
474478
| `last_event_location` | GeoJSON [Point Feature][point-geo]| Required | Location of vehicle's last event. See also [Stop-based Geographic Data][stop-based-geo]. |
475479
| `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]. |
476-
| `battery_percent` | Integer | Required if Applicable | Percent battery charge of vehicle, expressed between 0 and 100 |
477-
| `fuel_percent` | Integer | Required if Applicable | Percent fuel in vehicle, expressed between 0 and 100 |
478-
479480

480481
[Top][toc]
481482

0 commit comments

Comments
 (0)