You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: agency/README.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,8 +70,9 @@ See the [GBFS Requirement](/README.md#gbfs-requirement) language for more detail
70
70
71
71
The `/vehicles` endpoint returns the specified vehicle (if a device_id is provided) or a list of known vehicles. Providers can only retrieve data for vehicles in their registered fleet. Contains vehicle properties that do not change often.
72
72
73
-
Endpoint: `/vehicles/{device_id}`
74
-
Method: `GET`
73
+
**Endpoint**: `/vehicles/{device_id}`
74
+
**Method:**`POST`
75
+
**Payload:** An array of [Vehicles](/data-types.md#vehicles)
75
76
76
77
Path Params:
77
78
@@ -105,8 +106,9 @@ _No content returned on vehicle not found._
105
106
106
107
The `/vehicles/status` endpoint returns information about the specified vehicle (if a device_id is provided) or a list of known vehicles current state. Providers can only retrieve data for vehicles in their registered fleet. Contains specific vehicle properties that are updated frequently.
107
108
108
-
Endpoint: `/vehicles/status/{device_id}`
109
-
Method: `GET`
109
+
**Endpoint**: `/vehicles/status/{device_id}`
110
+
**Method:**`POST`
111
+
**Payload:** An array of [Vehicles](/data-types.md#vehicle-status) objects
110
112
111
113
Path Params:
112
114
@@ -214,7 +216,7 @@ The vehicle `/telemetry` endpoint allows a Provider to send vehicle telemetry da
214
216
215
217
**Endpoint**: `/telemetry`
216
218
**Method**: `POST`
217
-
**Payload**: An array of [Vehicle Telemetry][vehicle-telemetry]
219
+
**Payload**: An array of vehicle [Telemetry][vehicle-telemetry]
|`device_id`| UUID | Required |ID used in [Register](#vehicle---register)|
116
+
|`device_id`| UUID | Required |A unique device ID in UUID format|
117
117
|`provider_id`| UUID | Required | A UUID for the Provider, unique within MDS. See MDS [provider list](/providers.csv). |
118
118
|`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. |
119
119
|`telemetry_id`| UUID | Required | ID used for uniquely-identifying a Telemetry entry |
**`data` Payload:** `{ "telemetry": [] }`, an array of `telemetry` objects
328
+
**`data` Payload:** `{ "telemetry": [] }`, an array of [Vehicle Telemetry][vehicle-telemetry] objects
329
329
330
330
[Top][toc]
331
331
@@ -345,13 +345,13 @@ The `/events/recent` and `/events/historical/` endpoints return a list of Event
345
345
346
346
Unless stated otherwise by the municipality, this endpoint must return only those status changes with a `event_location` that [intersects](#intersection-operation) with the [municipality boundary](#municipality-boundary).
347
347
348
-
> Note: As a result of this definition, consumers should query the [trips endpoint][trips] to infer when vehicles enter or leave the municipality boundary.
348
+
> Note: As a result of this definition, consumers should query the [trips endpoint](#trips) to infer when vehicles enter or leave the municipality boundary.
349
349
350
350
**Endpoint:** `/events/historical`
351
351
**Method:** `GET`
352
352
**[Beta feature][beta]:** No
353
353
**Schema:** [`events` schema][events-schema]
354
-
**`data` Payload:** `{ "data": [] }`, an array of [Vehicle Event Data](#vehicle-event-data)
354
+
**`data` Payload:** `{ "data": [] }`, an array of [Events](/data-types.md#events) object
355
355
356
356
[Top][toc]
357
357
@@ -402,7 +402,7 @@ See also [Stop-based Geographic Data][stop-based-geo].
402
402
**Method:** `GET`
403
403
**[Beta feature][beta]:** No (as of 1.0.0)
404
404
**Schema:** [`events` schema][events-schema]
405
-
**`data` Payload:** `{ "events": [] }`, an array of Event objects
405
+
**`data` Payload:** `{ "events": [] }`, an array of [Events](/data-types.md#events) object objects
406
406
407
407
#### Recent Events - Query Parameters
408
408
@@ -493,7 +493,7 @@ See [Provider examples](examples.md#reports).
0 commit comments