Skip to content

Commit 3d34eb2

Browse files
authored
Added TOC top links
1 parent 983a99f commit 3d34eb2

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

agency/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,28 @@ This specification contains a collection of RESTful APIs used to specify the dig
2020

2121
This specification uses data types including timestamps, UUIDs, and vehicle state definitions as described in the MDS [General Information][general] document.
2222

23+
[Top][toc]
24+
2325
### Versioning
2426

2527
`agency` APIs must handle requests for specific versions of the specification from clients.
2628

2729
Versioning must be implemented as specified in the [Versioning section][versioning].
2830

31+
[Top][toc]
32+
2933
### Responses and Error Messages
3034

3135
See the [Responses][responses] and [Error Messages][error-messages] sections.
3236

37+
[Top][toc]
38+
3339
### Authorization
3440

3541
When making requests, the Agency API expects `provider_id` to be part of the claims in a [JWT](https://jwt.io/) `access_token` in the `Authorization` header, in the form `Authorization: Bearer <access_token>`. The token issuance, expiration and revocation policies are at the discretion of the Agency.
3642

43+
[Top][toc]
44+
3745
## Vehicles
3846

3947
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.
@@ -83,6 +91,8 @@ A vehicle record is as follows:
8391

8492
_No content returned on vehicle not found._
8593

94+
[Top][toc]
95+
8696
## Vehicle - Register
8797

8898
The `/vehicles` registration endpoint is used to register a vehicle for use in the Agency jurisdiction.
@@ -120,6 +130,8 @@ _No content returned on success._
120130
| -------------------- | ------------------------------------------------- | ------------------------------- |
121131
| `already_registered` | A vehicle with `device_id` is already registered | |
122132

133+
[Top][toc]
134+
123135
## Vehicle - Update
124136

125137
The `/vehicles` update endpoint is used to update some mutable aspect of a vehicle. For now, only `vehicle_id`.
@@ -148,6 +160,8 @@ _No content returned on success._
148160

149161
_No content returned if no vehicle matching `device_id` is found._
150162

163+
[Top][toc]
164+
151165
## Vehicle - Event
152166

153167
The vehicle `/event` endpoint allows the Provider to control the state of the vehicle including deregister a vehicle from the fleet.
@@ -185,6 +199,8 @@ Body Params:
185199
| `missing_param` | A required parameter is missing | Array of missing parameters |
186200
| `unregistered` | Vehicle is not registered | |
187201

202+
[Top][toc]
203+
188204
## Vehicle - Telemetry
189205

190206
The vehicle `/telemetry` endpoint allows a Provider to send vehicle telemetry data in a batch for any number of vehicles in the fleet.
@@ -214,6 +230,8 @@ Body Params:
214230
| `invalid_data` | None of the provided data was valid. | |
215231
| `missing_param` | A required parameter is missing. | Array of missing parameters |
216232

233+
[Top][toc]
234+
217235
## Telemetry Data
218236

219237
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).
@@ -234,6 +252,8 @@ A standard point of vehicle telemetry. References to latitude and longitude impl
234252
| `charge` | Float | Required if Applicable | Percent battery charge of vehicle, expressed between 0 and 1 |
235253
| `stop_id` | UUID | Required if Applicable | Stop that the vehicle is currently located at. Only applicable for _docked_ Micromobility. See [Stops][stops] |
236254

255+
[Top][toc]
256+
237257
## Stops
238258

239259
The `/stops` endpoint allows an agency to register city-managed Stops, or a provider to register self-managed Stops.

0 commit comments

Comments
 (0)