Skip to content

Commit 9a4aa9e

Browse files
authored
Updated Agency TOC
1 parent e01f032 commit 9a4aa9e

1 file changed

Lines changed: 13 additions & 10 deletions

File tree

agency/README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,16 @@ This specification contains a collection of RESTful APIs used to specify the dig
88
## Table of Contents
99

1010
* [General Information](#general-information)
11+
* [Versioning](#versioning)
12+
* [Responses and Error Messages](#responses-and-error-messages)
13+
* [Authorization](#authorization)
1114
* [Vehicles](#vehicles)
12-
* [Vehicle Registration](#vehicle---register)
13-
* [Vehicle Update](#vehicle---update)
14-
* [Vehicle Events](#vehicle---event)
15-
* [Vehicles Telemetry](#vehicles---telemetry)
16-
* [Telemetry Data](#telemetry-data)
17-
* [Stops](#stops)
15+
* [Vehicle - Register](#vehicle---register)
16+
* [Vehicle - Update](#vehicle---update)
17+
* [Vehicle - Events](#vehicle---event)
18+
* [Vehicle - Telemetry](#vehicle---telemetry)
19+
* [Telemetry Data](#telemetry-data)
20+
* [Stops](#stops)
1821

1922
## General information
2023

@@ -83,7 +86,7 @@ A vehicle record is as follows:
8386

8487
_No content returned on vehicle not found._
8588

86-
## Vehicle Registration
89+
## Vehicle - Register
8790

8891
The `/vehicles` registration endpoint is used to register a vehicle for use in the Agency jurisdiction.
8992

@@ -159,7 +162,7 @@ Path Params:
159162

160163
| Field | Type | Required/Optional | Field Description |
161164
| ------------ | ---- | ----------------- | ---------------------------------------- |
162-
| `device_id` | UUID | Required | ID used in [Register](#vehicle-register) |
165+
| `device_id` | UUID | Required | ID used in [Register](#vehicle---register) |
163166

164167
Body Params:
165168

@@ -185,7 +188,7 @@ Body Params:
185188
| `missing_param` | A required parameter is missing | Array of missing parameters |
186189
| `unregistered` | Vehicle is not registered | |
187190

188-
## Vehicles - Telemetry
191+
## Vehicle - Telemetry
189192

190193
The vehicle `/telemetry` endpoint allows a Provider to send vehicle telemetry data in a batch for any number of vehicles in the fleet.
191194

@@ -220,7 +223,7 @@ A standard point of vehicle telemetry. References to latitude and longitude impl
220223

221224
| Field | Type | Required/Optional | Field Description |
222225
| -------------- | -------------- | --------------------- | ------------------------------------------------------------ |
223-
| `device_id` | UUID | Required | ID used in [Register](#vehicle-register) |
226+
| `device_id` | UUID | Required | ID used in [Register](#vehicle---register) |
224227
| `timestamp` | [timestamp][ts] | Required | Date/time that event occurred. Based on GPS or GNSS clock |
225228
| `gps` | Object | Required | Telemetry position data |
226229
| `gps.lat` | Double | Required | Latitude of the location |

0 commit comments

Comments
 (0)