From 7153b1f4fccbc7ddeceadd789ae91f6e3e924f53 Mon Sep 17 00:00:00 2001 From: Neil Goldader Date: Tue, 8 Sep 2020 14:16:35 -0400 Subject: [PATCH 1/3] Add requested_trip_start_location --- agency/README.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/agency/README.md b/agency/README.md index daf18353..b9ff24d3 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 | +| requested_trip_start_location | { lat: number, lng: number } | Required | Location where the customer requested the trip to start. | +| 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] | **Endpoint:** `/trips` **Method:** `POST` From 9805fcd28214d37d40e2d104757a83ea0082f39b Mon Sep 17 00:00:00 2001 From: Neil Goldader Date: Tue, 8 Sep 2020 14:18:44 -0400 Subject: [PATCH 2/3] Formatting cleanup --- agency/README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/agency/README.md b/agency/README.md index b9ff24d3..44017fa4 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 | -| requested_trip_start_location | { lat: number, lng: number } | Required | Location where the customer requested the trip to start. | -| 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 | +| requested_trip_start_location | `{ lat: number, lng: number }` | Required | Location where the customer requested the trip to start. | +| 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] | **Endpoint:** `/trips` **Method:** `POST` From 8ce84d1e023a5a1dd87afce1ddf976c17d881fce Mon Sep 17 00:00:00 2001 From: Neil Goldader Date: Wed, 9 Sep 2020 16:46:51 -0400 Subject: [PATCH 3/3] Update requirements --- agency/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/agency/README.md b/agency/README.md index 44017fa4..829b43eb 100644 --- a/agency/README.md +++ b/agency/README.md @@ -369,10 +369,10 @@ The reservation method enum describes the different ways in which a passenger ca |-------------------------------|--------------------------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | trip_id | UUID | Required | UUID for the trip this payload pertains to | | provider_id | UUID | Required | Provider which managed this trip | -| requested_trip_start_location | `{ lat: number, lng: number }` | Required | Location where the customer requested the trip to start. | | 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) | +| requested_trip_start_location | `{ lat: number, lng: number }` | Conditionally Required | Location where the customer requested the trip to start (required if this is within jurisdictional boundaries) | | 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) |