add provider_id for telemetry

Author: marie-x

agency/README.md

@@ -90,18 +90,9 @@ Method: `POST`
 
 Body Params:
 
-| Field        | Type    | Required/Optional | Field Description                                                    |
-| ------------ | ------- | ----------------- | -------------------------------------------------------------------- |
-| `device_id`  | UUID    | Required          | Provided by Operator to uniquely identify a vehicle                  |
-| `vehicle_id` | String  | Required          | Vehicle Identification Number (vehicle_id) visible on vehicle        |
-| `vehicle_type`       | Enum    | Required          | [Vehicle Type][vehicle-types]                                        |
-| `mode`       | Enum    | Required          | [Mobility Mode][modes]                                        |
-| `propulsion_types` | Enum[]  | Required          | Array of [Propulsion Type][propulsion-types]; allows multiple values |
-| `vehicle_attributes` | Conditionally Required | Array of [vehicle attributes](/modes/#vehicle-attributes)   | Vehicle attributes appropriate for the current [mode][modes] |
-| `battery_capacity` | Integer  | Required if Available | Capacity of battery expressed as milliamp hours (mAh) |
-| `fuel_capacity` | Integer  | Required if Available | Capacity of fuel tank (liquid, solid, gaseous) expressed in liters |
-
-201 Success Response:
+TODO a list of Vehicle records FIXME
+
+200 Success Response:
 
 _No content returned on success._
 
@@ -120,36 +111,6 @@ _No content returned on success._
 
 [Top][toc]
 
-## Vehicle - Update
-
-The `/vehicles` update endpoint is used to update some mutable aspect of a vehicle. For now, only `vehicle_id`.
-
-Endpoint: `/vehicles/{device_id}`
-Method: `PUT`
-
-Body Params:
-
-| Field        | Type    | Required/Optional | Field Description                                                    |
-| ------------ | ------- | ----------------- | -------------------------------------------------------------------- |
-| `vehicle_id` | String  | Required          | License Plate (if present) or VIN visible on a vehicle               |
-
-200 Success Response:
-
-_No content returned on success._
-
-400 Failure Response:
-
-| `error`              | `error_description`                               | `error_details`[]               |
-| -------------------- | ------------------------------------------------- | ------------------------------- |
-| `bad_param`          | A validation error occurred.                      | Array of parameters with errors |
-| `missing_param`      | A required parameter is missing.                  | Array of missing parameters     |
-
-404 Failure Response:
-
-_No content returned if no vehicle matching `device_id` is found._
-
-[Top][toc]
-
 ## Vehicles - Events
 
 The vehicle `/events` endpoint allows the Provider to submit events describing the state changes of multiple vehicles.
@@ -225,10 +186,12 @@ The `/stops` endpoint allows an agency to register city-managed Stops, or a prov
 **[Beta feature][beta]:** Yes (as of 1.0.0). [Leave feedback](https://github.com/openmobilityfoundation/mobility-data-specification/issues/638)    
 **Request Body**: An array of [Stops][stops]
 
-201 Success Response:
+200 Success Response:
 
 _No content returned on success._
 
+(?) TODO FIXME resolve bulk return codes
+
 400 Failure Response:
 
 | `error`              | `error_description`                               | `error_details`[]               |

data-types.md

@@ -35,6 +35,8 @@ A vehicle record is as follows:
 
 Note that the only mutable field is `vehicle_id`.
 
+(?) Move `vehicle_id` into events?
+
 [Top][toc]
 
 ### Propulsion Types
@@ -92,6 +94,7 @@ Events represent changes in vehicle status.
 | `device_id` | UUID | Required | A unique device ID in UUID format |
 | `provider_id` | UUID | Required | A UUID for the Provider, unique within MDS. See MDS [provider list](/providers.csv). |
 | `data_provider_id` | UUID | Optional | If different than `provider_id`, a UUID for the data solution provider managing the data feed in this endpoint. See MDS [provider list](/providers.csv) which includes both service operators and data solution providers. |
+| `event_id` | UUID | Required | A unique event ID |
 | `vehicle_id` | String | Required | A unique vehicle identifier (visible code, license plate, etc), visible on the vehicle itself |
 | `vehicle_state` | Enum | Required | See [vehicle state][vehicle-states] table |
 | `event_types` | Enum[] | Required | Vehicle [event types][vehicle-events] for state change, with allowable values determined by `vehicle_state` |
@@ -117,8 +120,10 @@ A standard point of vehicle telemetry. References to latitude and longitude impl
 
 | Field          | Type           | Required/Optional     | Field Description                                            |
 | -------------- | -------------- | --------------------- | ------------------------------------------------------------ |
-| `telemetry_id` | UUID           | Required              | ID used for uniquely-identifying a Telemetry entry |
 | `device_id`    | UUID           | Required              | ID used in [Register](#vehicle---register)                     |
+| `provider_id` | UUID | Required | A UUID for the Provider, unique within MDS. See MDS [provider list](/providers.csv). |
+| `data_provider_id` | UUID | Optional | If different than `provider_id`, a UUID for the data solution provider managing the data feed in this endpoint. See MDS [provider list](/providers.csv) which includes both service operators and data solution providers. |
+| `telemetry_id` | UUID           | Required              | ID used for uniquely-identifying a Telemetry entry |
 | `timestamp`    | [Timestamp][ts]| Required              | Date/time that event occurred. Based on GPS or GNSS clock            |
 | `trip_ids`     | UUID[]         | Required              | If telemetry occurred during a trip, the ID of the trip(s).  If not in a trip, `null`.
 | `journey_id`   | UUID           | Required              | If telemetry occurred during a trip, the ID of the journey.  If not in a trip, `null`.
@@ -214,8 +219,8 @@ A Trip is defined by the following structure:
 | `fare_attributes`        | Map             | Optional               | **[Mode](/modes#list-of-supported-modes) Specific**. [Fare attributes](/modes#fare-attributes) given as unordered key-value pairs |
 | `start_time`             | [Timestamp][ts] | Required               | Start of the passenger/driver trip |
 | `end_time`               | [Timestamp][ts] | Required               | End of the passenger/driver trip |
-| `start_location`         | [Point](point)  | Required               | Location of the start of the trip. See also [Stop-based Geographic Data][stop-based-geo]. |
-| `end_location`           | [Point](point)  | Required               | Location of the end of the trip. See also [Stop-based Geographic Data][stop-based-geo]. |
+| `start_location`         | [GPS](gps)  | Required               | Location of the start of the trip. |
+| `end_location`           | [GPS](gps)  | Required               | Location of the end of the trip. |
 | `publication_time`       | [Timestamp][ts] | Optional               | Date/time that trip became available through the trips endpoint |
 | `reservation_attributes` | [Reservation](#reservation-data) | Required if available | Reservation details, if a reservation initiated this trip
 | `accessibility_options`  | Enum[]          | Optional               | The **union** of any accessibility options requested, and used. E.g. if the passenger requests a vehicle with `wheelchair_accessible`, but doesn’t utilize the features during the trip, the trip payload will include `accessibility_options: ['wheelchair_accessible']`. See [accessibility-options][accessibility-options] |