Skip to content

Commit 7a1117f

Browse files
committed
reservation info is also mode-specific
1 parent f99d62e commit 7a1117f

1 file changed

Lines changed: 0 additions & 37 deletions

File tree

data-types.md

Lines changed: 0 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -245,43 +245,6 @@ Examples of mode-specific `trip_attributes`:
245245

246246
[Top][toc]
247247

248-
### Reservation Data
249-
250-
A Reservation is defined as follows:
251-
252-
| Field | Type | Required/Optional | Comments |
253-
| ----- | ---- | ----------------- | -------- |
254-
| `reservation_method` | Enum | Required | Way the customer created their reservation, see [reservation-method](#reservation-method) |
255-
| `reservation_time` | Timestamp | Required | Time the customer *requested* a reservation |
256-
| `reservation_type` | Enum | Required | Type of reservation, see [reservation-type](#reservation-type) |
257-
| `quoted_trip_start_time` | Timestamp | Required | Time the trip was estimated or scheduled to start, that was provided to the passenger |
258-
| `requested_trip_start_location` | [GPS][gps] | Conditionally Required | Location where the customer requested the trip to start (required if this is within jurisdictional boundaries) |
259-
260-
[Top][toc]
261-
262-
#### Reservation Type
263-
264-
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`.
265-
266-
| `reservation_type` | Description |
267-
|--------------------|------------------------------------------------------------------------|
268-
| `on_demand` | The passenger requested the vehicle as soon as possible |
269-
| `scheduled` | The passenger requested the vehicle for a scheduled time in the future |
270-
271-
[Top][toc]
272-
273-
#### Reservation Method
274-
275-
The reservation method enum describes the different ways in which a passenger can create their reservation.
276-
277-
| `reservation_method` | Description |
278-
|----------------------|-----------------------------------------------------------|
279-
| `app` | Reservation was made through an application (mobile/web) |
280-
| `street_hail` | Reservation was made by the passenger hailing the vehicle |
281-
| `phone_dispatch` | Reservation was made by calling the dispatch operator |
282-
283-
[Top][toc]
284-
285248
[agency]: /agency/README.md
286249
[accessability-options]: /modes/README.md#accessibility-options
287250
[decimal-degrees]: https://en.wikipedia.org/wiki/Decimal_degrees

0 commit comments

Comments
 (0)