You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modes/passenger-services.md
+30-30Lines changed: 30 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -88,17 +88,17 @@ The `trip_attributes` object **may** have the following key value pairs:
88
88
-`app_name` (text, optional): name of the app used to reserve the trip which could be provider's app or 3rd party app
89
89
-`passenger_count` (integer, required): unique count of passengers transported during trip duration
90
90
-`requested_time` ([Timestamp][ts], required): when the passenger requested the trip
91
-
-`requested_trip_start_location` ([GPS](gps), [Conditionally Required](./general-information.md#conditionally-required-fields]): Location where the customer requested the trip to start (required if this is within jurisdictional boundaries)
91
+
-`requested_trip_start_location` ([GPS](gps), [Conditionally Required](../general-information.md#conditionally-required-fields)): Location where the customer requested the trip to start (required if this is within jurisdictional boundaries)
92
92
-`quoted_trip_start_time` ([Timestamp][ts], Required): Time the trip was estimated or scheduled to start, that was provided to the passenger
93
-
-`dispatch_time` ([Timestamp][ts], [Conditionally Required](./general-information.md#conditionally-required-fields]): Time the vehicle was dispatched to the customer (required if trip was dispatched)
94
-
-`trip_wait_time` (milliseconds, [Optional](./general-information.md#optional-fields]): part of the passenger trip where the vehicle was moving slow or stopped (e.g. <12mph), which is a different fare rate in some jurisdictions
95
-
-`trip_fare_time` (milliseconds, [Optional](./general-information.md#optional-fields]): part of the passenger trip where the vehicle was moving more quickly (e.g. >12mph), which is a different fare rate in some jurisdictions
96
-
-`pickup_address` (text, [Optional](./general-information.md#optional-fields]): street address where the trip originated from
97
-
-`dropoff_address` (text, [Optional](./general-information.md#optional-fields]): street address where the trip ended
98
-
-`permit_license_number` (string, [Optional](./general-information.md#optional-fields]) - The permit license number of the organization that dispatched the vehicle
99
-
-`driver_id` (string, [Optional](./general-information.md#optional-fields]): Universal identifier of a specific driver, static across operators, like a driver's license number. Could also be used as a lookup in an agency's internal driver system.
100
-
-`wheelchair_transported` (boolean, [Optional](./general-information.md#optional-fields]) - was a wheelchair transported as part of this trip?
101
-
-`cancellation_reason` (String, [Conditionally Required](./general-information.md#conditionally-required-fields]): 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)
93
+
-`dispatch_time` ([Timestamp][ts], [Conditionally Required](../general-information.md#conditionally-required-fields)): Time the vehicle was dispatched to the customer (required if trip was dispatched)
94
+
-`trip_wait_time` (milliseconds, [Optional](../general-information.md#optional-fields)): part of the passenger trip where the vehicle was moving slow or stopped (e.g. <12mph), which is a different fare rate in some jurisdictions
95
+
-`trip_fare_time` (milliseconds, [Optional](../general-information.md#optional-fields)): part of the passenger trip where the vehicle was moving more quickly (e.g. >12mph), which is a different fare rate in some jurisdictions
96
+
-`pickup_address` (text, [Optional](../general-information.md#optional-fields)): street address where the trip originated from
97
+
-`dropoff_address` (text, [Optional](../general-information.md#optional-fields)): street address where the trip ended
98
+
-`permit_license_number` (string, [Optional](../general-information.md#optional-fields)) - The permit license number of the organization that dispatched the vehicle
99
+
-`driver_id` (string, [Optional](../general-information.md#optional-fields)): Universal identifier of a specific driver, static across operators, like a driver's license number. Could also be used as a lookup in an agency's internal driver system.
100
+
-`wheelchair_transported` (boolean, [Optional](../general-information.md#optional-fields)) - was a wheelchair transported as part of this trip?
101
+
-`cancellation_reason` (String, [Conditionally Required](../general-information.md#conditionally-required-fields)): 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)
102
102
103
103
[Top][toc]
104
104
@@ -108,18 +108,18 @@ The `fare_attributes` object **may** have the following key value pairs:
-`fare_type` (enumerated, required): `meter_fare`, `upfront_pricing`, `flat_rate`. Indicator of which rate was charged.
111
-
-`meter_fare_amount` (currency, [Conditionally Required](./general-information.md#conditionally-required-fields]): if `upfront_pricing` is used as a `fare_type` include what the metered fare would have been if `meter_fare` would have been used. Allows cost comparison in evaluation of programs and pilots.
112
-
-`tolls` (currency, [Optional](./general-information.md#optional-fields]) - Sum of any and all tolls charged for the trip, such as bridge tolls
113
-
-`base_rate` (currency, [Optional](./general-information.md#optional-fields]) - Minimum fare to be charged as soon as the trip starts.
114
-
-`exit_fee` (currency, [Optional](./general-information.md#optional-fields]) - Fee to exit location, like an airport
115
-
-`other_fees` (currency, [Optional](./general-information.md#optional-fields]) - amount of any fees charged to the customer. Includes baggage fees, cleaning fee. Excludes other fees returned.
116
-
-`tip` (currency, [Optional](./general-information.md#optional-fields]) - amount of tip paid by customer
117
-
-`extra_amount` (currency, [Optional](./general-information.md#optional-fields]) - miscellaneous extra amounts charged to customer not covered by other fields.
118
-
-`taxes` (currency, [Optional](./general-information.md#optional-fields]) - amount of taxes paid for the ride
119
-
-`surcharge` (currency, [Optional](./general-information.md#optional-fields]) - any surcharge pricing
120
-
-`commission` (currency, [Optional](./general-information.md#optional-fields]) - any extra commission for the ride
121
-
-`driver_trip_pay` (currency, [Optional](./general-information.md#optional-fields]) - The payment the driver received for the trip
122
-
-`rate_code_id` (enumerated, [Optional](./general-information.md#optional-fields]) - one of `meter_fare`, `shared`, `out_of_town`, `disabled`, `upfront_pricing`, `promo_rate`
111
+
-`meter_fare_amount` (currency, [Conditionally Required](../general-information.md#conditionally-required-fields)): if `upfront_pricing` is used as a `fare_type` include what the metered fare would have been if `meter_fare` would have been used. Allows cost comparison in evaluation of programs and pilots.
112
+
-`tolls` (currency, [Optional](../general-information.md#optional-fields)) - Sum of any and all tolls charged for the trip, such as bridge tolls
113
+
-`base_rate` (currency, [Optional](../general-information.md#optional-fields)) - Minimum fare to be charged as soon as the trip starts.
114
+
-`exit_fee` (currency, [Optional](../general-information.md#optional-fields)) - Fee to exit location, like an airport
115
+
-`other_fees` (currency, [Optional](../general-information.md#optional-fields)) - amount of any fees charged to the customer. Includes baggage fees, cleaning fee. Excludes other fees returned.
116
+
-`tip` (currency, [Optional](../general-information.md#optional-fields)) - amount of tip paid by customer
117
+
-`extra_amount` (currency, [Optional](../general-information.md#optional-fields)) - miscellaneous extra amounts charged to customer not covered by other fields.
118
+
-`taxes` (currency, [Optional](../general-information.md#optional-fields)) - amount of taxes paid for the ride
119
+
-`surcharge` (currency, [Optional](../general-information.md#optional-fields)) - any surcharge pricing
120
+
-`commission` (currency, [Optional](../general-information.md#optional-fields)) - any extra commission for the ride
121
+
-`driver_trip_pay` (currency, [Optional](../general-information.md#optional-fields)) - The payment the driver received for the trip
122
+
-`rate_code_id` (enumerated, [Optional](../general-information.md#optional-fields)) - one of `meter_fare`, `shared`, `out_of_town`, `disabled`, `upfront_pricing`, `promo_rate`
123
123
124
124
[Top][toc]
125
125
@@ -131,14 +131,14 @@ _See more available vehicle attributes and accessibility attributes for any mode
131
131
132
132
The `vehicle_attributes` object **may** have the following key value pairs:
-`vin` (string, [Optional](./general-information.md#optional-fields]) - the Vehicle Identification Number of the vehicle
139
-
-`placard_number` (string, [Optional](./general-information.md#optional-fields]) - the registered placard number of the vehicle
140
-
-`license_plate` (string, [Optional](./general-information.md#optional-fields]) - the registered vehicle license/number/registration plate identifier on the vehicle
141
-
-`inspection_date` (date YYYY-MM-DD, [Optional](./general-information.md#optional-fields]) - the date of the last inspection of the vehicle
-`vin` (string, [Optional](../general-information.md#optional-fields)) - the Vehicle Identification Number of the vehicle
139
+
-`placard_number` (string, [Optional](../general-information.md#optional-fields)) - the registered placard number of the vehicle
140
+
-`license_plate` (string, [Optional](../general-information.md#optional-fields)) - the registered vehicle license/number/registration plate identifier on the vehicle
141
+
-`inspection_date` (date YYYY-MM-DD, [Optional](../general-information.md#optional-fields)) - the date of the last inspection of the vehicle
0 commit comments