Skip to content

Commit 86dfae9

Browse files
authored
Agency: clarify vehicle endpoint requirements
1 parent 3e246c5 commit 86dfae9

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

agency/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -72,19 +72,19 @@ If `device_id` is specified, `GET` will return a single vehicle record, otherwis
7272

7373
A vehicle record is as follows:
7474

75-
| Field | Type | Field Description |
76-
| ------------- | --------- | ----------------------------------------------------------------------------- |
77-
| `device_id` | UUID | Provided by Operator to uniquely identify a vehicle |
78-
| `provider_id` | UUID | Issued by City and [tracked](../providers.csv) |
79-
| `vehicle_id` | String | Vehicle Identification Number (vehicle_id) visible on vehicle |
80-
| `type` | Enum | [Vehicle Type](#vehicle-type) |
81-
| `propulsion` | Enum[] | Array of [Propulsion Type](#propulsion-type); allows multiple values |
82-
| `year` | Integer | Year Manufactured |
83-
| `mfgr` | String | Vehicle Manufacturer |
84-
| `model` | String | Vehicle Model |
85-
| `status` | Enum | Current vehicle status. See [Vehicle Status](#vehicle-events) |
86-
| `prev_event` | Enum | Last [Vehicle Event](#vehicle-events) |
87-
| `updated` | Timestamp | Date of last event update |
75+
| Field | Type | Required/Optional | Field Description |
76+
| ------------- | --------- | --------------------- | ----------------------------------------------------------------------------- |
77+
| `device_id` | UUID | Required | Provided by Operator to uniquely identify a vehicle |
78+
| `provider_id` | UUID | Required | Issued by City and [tracked](../providers.csv) |
79+
| `vehicle_id` | String | Required | Vehicle Identification Number (vehicle_id) visible on vehicle |
80+
| `type` | Enum | Required | [Vehicle Type](#vehicle-type) |
81+
| `propulsion` | Enum[] | Required | Array of [Propulsion Type](#propulsion-type); allows multiple values |
82+
| `year` | Integer | Required if Available | Year Manufactured |
83+
| `mfgr` | String | Required if Available | Vehicle Manufacturer |
84+
| `model` | String | Required if Available | Vehicle Model |
85+
| `status` | Enum | Required if Available | Current vehicle status. See [Vehicle Status](#vehicle-events) |
86+
| `prev_event` | Enum | Required if Available | Last [Vehicle Event](#vehicle-events) |
87+
| `updated` | Timestamp | Required if Available | Date of last event update |
8888

8989
404 Failure Response:
9090

0 commit comments

Comments
 (0)