Skip to content

Commit

Permalink
Merge pull request #20 from lacuna-tech/feature/neil/add-scheduled-tr…
Browse files Browse the repository at this point in the history 
…ip-start-time

Feature/neil/add scheduled trip start time
  • Loading branch information
@avatarneil
avatarneil authored Sep 11, 2020
2 parents caff510 + 96cebd6 commit 5bc8025
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion agency/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down Expand Up @@ -372,6 +372,7 @@ The reservation method enum describes the different ways in which a passenger ca
| 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 |
| 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) |
Expand Down

0 comments on commit 5bc8025

Please sign in to comment.