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: provider/README.md
+10Lines changed: 10 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,6 +30,8 @@ The following information applies to all `provider` API endpoints. Details on pr
30
30
31
31
This specification uses data types including timestamps, UUIDs, and vehicle state definitions as described in the MDS [General Information][general-information] document.
32
32
33
+
[Top][toc]
34
+
33
35
### Versioning
34
36
35
37
`provider` APIs must handle requests for specific versions of the specification from clients.
@@ -164,6 +166,8 @@ Unless stated otherwise by the municipality, the trips endpoint must return all
164
166
|`actual_cost`| Integer | Optional | The actual cost, in the currency defined in `currency`, paid by the customer of the *mobility as a service* provider (see [Costs & Currencies][costs-and-currencies]) |
165
167
|`currency`| String | Optional, USD cents is implied if null.| An [ISO 4217 Alphabetic Currency Code][iso4217] representing the currency of the payee (see [Costs & Currencies][costs-and-currencies]) |
166
168
169
+
[Top][toc]
170
+
167
171
### Trips - Query Parameters
168
172
169
173
The `/trips` API should allow querying trips with the following query parameters:
@@ -178,6 +182,8 @@ Without an `end_time` query parameter, `/trips` shall return a `400 Bad Request`
178
182
179
183
For the near-ish real time use cases, please use the [events][events] endpoint.
180
184
185
+
[Top][toc]
186
+
181
187
### Routes
182
188
183
189
To represent a route, MDS `provider` APIs must create a GeoJSON [`FeatureCollection`][geojson-feature-collection], which includes every [observed point][geo] in the route, even those which occur outside the [municipality boundary][muni-boundary].
@@ -257,6 +263,8 @@ Unless stated otherwise by the municipality, this endpoint must return only thos
257
263
|`trip_id`| UUID | Required if Applicable | Trip UUID (foreign key to Trips API), required if `event_types` contains `trip_start`, `trip_end`, `trip_cancel`, `trip_enter_jurisdiction`, or `trip_leave_jurisdiction`|
258
264
|`associated_ticket`| String | Optional | Identifier for an associated ticket inside an Agency-maintained 311 or CRM system |
259
265
266
+
[Top][toc]
267
+
260
268
### Status Changes - Query Parameters
261
269
262
270
The `/status_changes` API should allow querying status changes with the following query parameters:
@@ -325,6 +333,8 @@ Should either side of the requested time range be missing, `/events` shall retur
325
333
326
334
Should either side of the requested time range be greater than 2 weeks before the time of the request, `/events` shall return a `400 Bad Request` error.
327
335
336
+
[Top][toc]
337
+
328
338
### Stops
329
339
330
340
Stop information should be updated on a near-realtime basis by providers who operate _docked_ mobility devices in a given municipality.
0 commit comments