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

Add a note about array Types to Provider #54

Merged
merged 2 commits into from
Sep 12, 2018
Merged

Add a note about array Types to Provider #54

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c2ea95
Remove unnecessary brackets
sethherr Sep 12, 2018
358332f
Add note about arry
sethherr Sep 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions provider/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Data: `{ "trips": [] }`, an array of objects with the following structure
| `device_id` | UUID | Required | A unique device ID in UUID format |
| `vehicle_id` | String | Required | The Vehicle Identification Number visible on the vehicle itself |
| `vehicle_type` | Enum | Required | See [vehicle types](#vehicle-types) table |
| `propulsion_type` | Enum[] | Required | See [propulsion types](#propulsion-types) table; allows multiple values |
| `propulsion_type` | Enum[] | Required | Array of [propulsion types](#propulsion-types); allows multiple values |
| `trip_id` | UUID | Required | A unique ID for each trip |
| `trip_duration` | Integer | Required | Time, in Seconds |
| `trip_distance` | Integer | Required | Trip Distance, in Meters |
Expand Down Expand Up @@ -172,13 +172,13 @@ Data: `{ "status_changes": [] }`, an array of objects with the following structu
| `device_id` | UUID | Required | A unique device ID in UUID format |
| `vehicle_id` | String | Required | The Vehicle Identification Number visible on the vehicle itself |
| `vehicle_type` | Enum | Required | see [vehicle types](#vehicle-types) table |
| `propulsion_type` | Enum[] | Required | See [propulsion types](#propulsion-types) table; allows multiple values |
| `propulsion_type` | Enum[] | Required | Array of [propulsion types](#propulsion-types); allows multiple values |
| `event_type` | Enum | Required | See [event types](#event-types) table |
| `event_type_reason` | Enum | Required | Reason for status change, allowable values determined by [`event type`](#event-types) |
| `event_time` | Unix Timestamp | Required | Date/time that event occurred, based on device clock |
| `event_location` | Point | Required | |
| `battery_pct` | Float | Required if Applicable | Percent battery charge of device, expressed between 0 and 1 |
| `associated_trips` | UUID[] | Optional based on device | For "Reserved" event types, associated trips (foreign key to Trips API) |
| `associated_trips` | UUID[] | Optional based on device | Array of UUID's. For "Reserved" event types, associated trips (foreign key to Trips API) |

### Event Types

Expand All @@ -201,4 +201,4 @@ All MDS compatible `provider` APIs must expose a [GBFS](https://github.com/NABSA

[Top][toc]

[toc]: #table-of-contents
[toc]: #table-of-contents