Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Agency: clarify vehicle endpoint requirements #465

Merged
merged 1 commit into from
Jun 11, 2020
Merged

Agency: clarify vehicle endpoint requirements #465

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
26 changes: 13 additions & 13 deletions agency/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,19 +72,19 @@ If `device_id` is specified, `GET` will return a single vehicle record, otherwis

A vehicle record is as follows:

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

404 Failure Response:

Expand Down