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

Suggested API additions #14

Merged
merged 2 commits into from
Jun 5, 2018
Merged

Suggested API additions #14

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e41d59a
Suggested API additions
Jun 3, 2018
76c029c
Changes to wording.
hunterowens Jun 5, 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
3 changes: 3 additions & 0 deletions provider/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,13 @@ Response:
| `trip_distance` | Integer | Required | Trip Distance, in Meters |
| `start_point` | Point | Required | |
| `end_point` | Point | Required | |
| `accuracy` | Integer | Required | The approximate level of accuracy, in meters, represented by start_point and end_point. |
| `route` | Line | Optional | |
| `sample_rate` | Integer | Optional | The frequency, in seconds, in which the route is sampled |
| `device_id` | UUID | Required | |
| `start_time` | Unix Timestamp | Required | |
| `end_time` | Unix Timestamp | Required | |
| `parking_verification` | String | Optional | A URL to a photo (or other evidence) of proper vehicle parking |
| `standard_cost` | Integer | Optional | The cost, in cents that it would cost to perform that trip in the standard operation of the System. |
| `actual_cost` | Integer | Optional | The actual cost paid by the user of the Mobility as a service provider |

Expand All @@ -60,6 +62,7 @@ Response:
| `availability_start_time` | Unix Timestamp | Required | |
| `availability_end_time` | Unix Timestamp | Required | If a device is still available, use NaN |
| `placement_reason` | Enum | Required | Reason for placement (`user_drop_off`, `rebalancing_drop_off`) |
| `allowed_placement` | Bool | Required | Indicates whether provider believes placement was allowable under service area rules. |
| `pickup_reason` | Enum | Required | Reason for removal (`user_pick_up`, `rebalacing_pick_up`, `out_of_service_area_pick_up`, `maintenance_pick_up`) |
| `associated_trips` | [UUID] | Optional | list of associated maintenance |

Expand Down