Skip to content

Commit 4d3993b

Browse files
committed
cleanup leftovers from rebase
also use link references
1 parent c3623e2 commit 4d3993b

1 file changed

Lines changed: 13 additions & 59 deletions

File tree

agency/README.md

Lines changed: 13 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -232,92 +232,46 @@ A standard point of vehicle telemetry. References to latitude and longitude impl
232232
| `gps.hdop` | Float | Required if Available | Horizontal GPS or GNSS accuracy value (see [hdop][hdop]) |
233233
| `gps.satellites` | Integer | Required if Available | Number of GPS or GNSS satellites
234234
| `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] |
236236

237237
## Stops
238238

239239
The `/stops` endpoint allows an agency to register Stops.
240240

241241
**Endpoint:** `/stops`
242242
**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]
245245

246246
**Endpoint:** `/stops`
247247
**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:
250+
250251
| Field | Required/Optional | Description |
251252
|---------------------|-------------------|---------------------------------------------|
252-
| stop_id | Required |See [Stops](/general-information.md#stop) |
253-
| status | Optional |See [Stops](/general-information.md#stop) |
254-
| num_spots_disabled | Optional |See [Stops](/general-information.md#stop) |
253+
| stop_id | Required |See [Stops][stops] |
254+
| status | Optional |See [Stops][stops] |
255+
| num_spots_disabled | Optional |See [Stops][stops] |
255256

256257
TBD -- Are there additional fields that should be permitted to update with a PUT?
257258

258259
**Endpoint:** `/stops/:stop_id`
259260
**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]
262263

263264
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.
264265

265-
## Enum Definitions
266-
267-
### Area Types
268-
269-
| `type` | Description |
270-
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
271-
| `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 |
275-
276-
### Vehicle Type
277-
278-
| `type` |
279-
| --------- |
280-
| `bicycle` |
281-
| `car` |
282-
| `scooter` |
283-
284-
### Propulsion Type
285-
286-
| `propulsion` | Description |
287-
| ----------------- | ------------------------------------------------------ |
288-
| `human` | Pedal or foot propulsion |
289-
| `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.
305-
306-
### Error Message Format
307-
308-
| Field | Type | Field Description |
309-
| ------------------- | -------- | ---------------------- |
310-
| `error` | String | Error message string |
311-
| `error_description` | String | Human readable error description (can be localized) |
312-
| `error_details` | String[] | Array of error details |
313-
314266
[Top][toc]
315267

268+
[beta]: /general-information.md#beta-features
316269
[general]: /general-information.md
317270
[error-messages]: /general-information.md#error-messages
318271
[hdop]: https://support.esri.com/en/other-resources/gis-dictionary/term/358112bd-b61c-4081-9679-4fca9e3eb926
319272
[propulsion-types]: /general-information.md#propulsion-types
320273
[responses]: /general-information.md#responses
274+
[stops]: /general-information#stops
321275
[toc]: #table-of-contents
322276
[ts]: /general-information.md#timestamps
323277
[vehicle-types]: /general-information.md#vehicle-types

0 commit comments

Comments
 (0)