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

Rename accessibility_options_used -> accessibility_options in Trips payload #17

Merged
merged 2 commits into from
Sep 8, 2020
Merged

Rename accessibility_options_used -> accessibility_options in Trips payload #17

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
90446d5
Rename accessibility_options_used -> accessibility_options, add more …
avatarneil Sep 4, 2020
1c41180
replace boarding with accessible
avatarneil Sep 4, 2020
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
28 changes: 14 additions & 14 deletions agency/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,20 +365,20 @@ The reservation method enum describes the different ways in which a passenger ca
| payment_methods | `{ [string]: number }` | Optional | Breakdown of different payment methods used for a trip, e.g. cash, card |

## Trip
| Field | Type | Required/Optional | Field Description |
|----------------------------|---------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| trip_id | UUID | Required | UUID for the trip this payload pertains to |
| provider_id | UUID | Required | Provider which managed this trip |
| reservation_method | Enum | Required | Way the customer created their reservation, see [reservation-method](#reservation-method) |
| reservation_time | Timestamp | Required | Time the customer *requested* a reservation |
| reservation_type | Enum | Required | Type of reservation, see [reservation-type](#reservation-type) |
| dispatch_time | Timestamp | Conditionally Required | Time the vehicle was dispatched to the customer (required if trip was dispatched) |
| trip_start_time | Timestamp | Conditionally Required | Time the trip started (required if trip started) |
| trip_end_time | Timestamp | Conditionally Required | Time the trip ended (required if trip was completed) |
| distance | Float | Conditionally Required | Total distance of the trip in meters (required if trip was completed) |
| cancellation_reason | string | Conditionally Required | The reason why a *driver* cancelled a reservation. (required if a driver cancelled a trip, and a `driver_cancellation` event_type was part of the trip) |
| fare | [Fare](#fare) | Conditionally Required | Fare for the trip (required if trip was completed) |
| accessibility_options_used | Enum[] | Optional | Accessibility options used in this trip. See [accessibility-options][accessibility-options] |
| Field | Type | Required/Optional | Field Description |
|-----------------------|---------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| trip_id | UUID | Required | UUID for the trip this payload pertains to |
| provider_id | UUID | Required | Provider which managed this trip |
| reservation_method | Enum | Required | Way the customer created their reservation, see [reservation-method](#reservation-method) |
| reservation_time | Timestamp | Required | Time the customer *requested* a reservation |
| reservation_type | Enum | Required | Type of reservation, see [reservation-type](#reservation-type) |
| dispatch_time | Timestamp | Conditionally Required | Time the vehicle was dispatched to the customer (required if trip was dispatched) |
| trip_start_time | Timestamp | Conditionally Required | Time the trip started (required if trip started) |
| trip_end_time | Timestamp | Conditionally Required | Time the trip ended (required if trip was completed) |
| distance | Float | Conditionally Required | Total distance of the trip in meters (required if trip was completed) |
| cancellation_reason | string | Conditionally Required | The reason why a *driver* cancelled a reservation. (required if a driver cancelled a trip, and a `driver_cancellation` event_type was part of the trip) |
| fare | [Fare](#fare) | Conditionally Required | Fare for the trip (required if trip was completed) |
| accessibility_options | Enum[] | Optional | The **union** of any accessibility options requested, and used. E.g. if the passenger requests a vehicle with `wheelchair_accessible`, but doesn’t utilize the features during the trip, the trip payload will include `accessibility_options: ['wheelchair_accessible']`. See [accessibility-options][accessibility-options] |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is supposed to be in the payload if the accessibility option is requested AND is used?

The link "accessibility-options" redirects to the agency spec, but that doesn't contain any mention of accessibility-options

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link ought to redirect to general-information.md, hm. In the case that it's requested and used, it's inclusive, so it should just be the same as if it was only requested.


**Endpoint:** `/trips`
**Method:** `POST`
Expand Down