From a4d2816b9d8e3ce72bea95d0eead2a9201e24470 Mon Sep 17 00:00:00 2001 From: Neil Goldader Date: Wed, 9 Sep 2020 09:44:11 -0400 Subject: [PATCH 1/3] Add scheduled_trip_start_time --- agency/README.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/agency/README.md b/agency/README.md index daf18353..891c0bd8 100644 --- a/agency/README.md +++ b/agency/README.md @@ -365,20 +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) | -| 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) | +| 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] | **Endpoint:** `/trips` **Method:** `POST` From 2c1ddebbe31ab388af301ce9c93a23aa6844efd2 Mon Sep 17 00:00:00 2001 From: Neil Goldader Date: Wed, 9 Sep 2020 09:45:56 -0400 Subject: [PATCH 2/3] Update reservation type description --- agency/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/agency/README.md b/agency/README.md index 891c0bd8..54895bbb 100644 --- a/agency/README.md +++ b/agency/README.md @@ -341,7 +341,7 @@ Path Params: If `stop_id` is specified, `GET` will return an array with a single stop record, otherwise it will be a list of all stop records. ## Reservation Type -The reservation type enum expresses the urgency of a given reservation. This can be useful when attempting to quantify metrics around trips: for example, computing passenger wait-time. In the `on_demand` case, passenger wait-time may be quantified by the delta between the time a passenger created their reservation, and the pick-up time; however, in the `scheduled` case, the wait time may be quantified based on the delta between ... TODO @avatarneil finish this +The reservation type enum expresses the urgency of a given reservation. This can be useful when attempting to quantify metrics around trips: for example, computing passenger wait-time. In the `on_demand` case, passenger wait-time may be quantified by the delta between the `reservation_time`, and the pick-up time; however, in the `scheduled` case, the wait time may be quantified based on the delta between the `scheduled_trip_start_time` found in the Trips payload, and the actual `trip_start_time`. | `reservation_type` | Description | |--------------------|------------------------------------------------------------------------| | `on_demand` | The passenger requested the vehicle as soon as possible | From 1eb549ac7662950269fc75dfd4e3a1b255647331 Mon Sep 17 00:00:00 2001 From: Neil Goldader Date: Thu, 10 Sep 2020 10:40:59 -0400 Subject: [PATCH 3/3] scheduled_trip_start_time -> quoted_trip_start_time --- agency/README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/agency/README.md b/agency/README.md index 54895bbb..8b035e31 100644 --- a/agency/README.md +++ b/agency/README.md @@ -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`