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
+13-59Lines changed: 13 additions & 59 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -232,92 +232,46 @@ A standard point of vehicle telemetry. References to latitude and longitude impl
232
232
|`gps.hdop`| Float | Required if Available | Horizontal GPS or GNSS accuracy value (see [hdop][hdop]) |
233
233
| `gps.satellites` | Integer | Required if Available | Number of GPS or GNSS satellites
234
234
|`charge`| Float | Required if Applicable | Percent battery charge of vehicle, expressed between 0 and 1 |
235
-
|`stop_id`| UUID | Required if Applicable | Stop that the vehicle is currently located at. Only applicable for _docked_ Micromobility. See [Stops](../general-information.md#stops)|
235
+
|`stop_id`| UUID | Required if Applicable | Stop that the vehicle is currently located at. Only applicable for _docked_ Micromobility. See [Stops][stops]|
236
236
237
237
## Stops
238
238
239
239
The `/stops` endpoint allows an agency to register Stops.
240
240
241
241
**Endpoint:**`/stops`
242
242
**Method:**`POST`
243
-
**[Beta feature](/general-information.md#beta-features):** Yes (as of 1.0.0)
244
-
**Request Body**: An array of [Stops](/general-information.md#stop)
243
+
**[Beta feature][beta]:** Yes (as of 1.0.0)
244
+
**Request Body**: An array of [Stops][stops]
245
245
246
246
**Endpoint:**`/stops`
247
247
**Method:**`PUT`
248
-
**[Beta feature](/general-information.md#beta-features):** Yes (as of 1.0.0)
249
-
**Request Body**: An array of subsets of [Stop](/general-information.md#stop) information, where the permitted subset fields are defined as:
248
+
**[Beta feature][beta]:** Yes (as of 1.0.0)
249
+
**Request Body**: An array of subsets of [Stop][stops] information, where the permitted subset fields are defined as:
TBD -- Are there additional fields that should be permitted to update with a PUT?
257
258
258
259
**Endpoint:**`/stops/:stop_id`
259
260
**Method:**`GET`
260
-
**[Beta feature](/general-information.md#beta-features):** Yes (as of 1.0.0)
261
-
**`data` Payload:**`{ "stops": [] }`, an array of [Stops](/general-information.md#stop)
261
+
**[Beta feature][beta]:** Yes (as of 1.0.0)
262
+
**`data` Payload:**`{ "stops": [] }`, an array of [Stops][stops]
262
263
263
264
In the case that a `stop_id` query parameter is specified, the `stops` array returned will only have one entry. In the case that no `stop_id` query parameter is specified, all stops will be returned.
|`unrestricted`| Areas where vehicles may be picked up/dropped off. A provider's unrestricted area shall be contained completely inside the agency's unrestricted area for the provider in question, but it need not cover the entire agency unrestricted area. See the provider version of the service areas endpoint |
272
-
|`restricted`| Areas where vehicle pick-up/drop-off is not allowed |
273
-
|`preferred_pick_up`| Areas where users are encouraged to pick up vehicles |
274
-
|`preferred_drop_off`| Areas where users are encouraged to drop off vehicles |
|`electric_assist`| Provides power only alongside human propulsion |
290
-
|`electric`| Contains throttle mode with a battery-powered motor |
291
-
|`combustion`| Contains throttle mode with a gas engine-powered motor |
292
-
293
-
A vehicle may have one or more values from the `propulsion`, depending on the number of modes of operation. For example, a scooter that can be powered by foot or by electric motor would have the `propulsion` represented by the array `['human', 'electric']`. A bicycle with pedal-assist would have the `propulsion` represented by the array `['human', 'electric_assist']` if it can also be operated as a traditional bicycle.
294
-
295
-
## Responses
296
-
297
-
298
-
***200:** OK: operation successful.
299
-
***201:** Created: `POST` operations, new object created
300
-
***400:** Bad request.
301
-
***401:** Unauthorized: Invalid, expired, or insufficient scope of token.
302
-
***404:** Not Found: Object does not exist, returned on `GET` or `POST` operations if the object does not exist.
303
-
***409:** Conflict: `POST` operations when an object already exists and an update is not possible.
304
-
***500:** Internal server error: In this case, the answer may contain a `text/plain` body with an error message for troubleshooting.
0 commit comments