Skip to content

Commit

Permalink
scheduled_trip_start_time -> quoted_trip_start_time
Browse files Browse the repository at this point in the history
  • Loading branch information
@avatarneil
avatarneil committed Sep 10, 2020
1 parent 2c1ddeb commit 1eb549a
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions agency/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -365,21 +365,21 @@ 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) |
| scheduled_trip_start_time | Timestamp | Conditionally Required | Time the trip was scheduled to start. Only applicable in the case where `reservation_type` is `scheduled` |
| 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] |
| 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) |
| quoted_trip_start_time | Timestamp | Required | Time the trip was estimated or scheduled to start, that was provided to the passenger |
| 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] |

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

0 comments on commit 1eb549a

Please sign in to comment.