Skip to content

Commit e01dc83

Browse files
committed
Added agency Reports
1 parent 7084307 commit e01dc83

1 file changed

Lines changed: 42 additions & 6 deletions

File tree

agency/README.md

Lines changed: 42 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ This specification contains a collection of RESTful APIs used to specify the dig
2424
* [Stops - Register](#stops---register)
2525
* [Stops - Update](#stops---update)
2626
* [Stops - Readback](#stops---readback)
27-
* [Reports](#Reports)
27+
* [Reports](#reports)
28+
* [Reports - Register](#reports---register)
2829

2930
## General information
3031

@@ -287,6 +288,40 @@ If `stop_id` is specified, `GET` will return an array with a single stop record,
287288

288289
[Top][toc]
289290

291+
## Reports
292+
293+
Reports are information that providers can send back to agencies containing aggregated data that is not contained within other MDS endpoints, like counts of special groups of riders. These supplemental reports are not a substitute for other MDS Provider endpoints.
294+
295+
The authenticated reports are monthly, historic flat files that may be pre-generated by the provider.
296+
297+
[Top][toc]
298+
299+
## Reports - register
300+
301+
The `/reports` endpoint allows an agency to register aggregated report counts in CSV structure.
302+
303+
**Endpoint:** `/reports`
304+
**Method:** `POST`
305+
**Payload**: A CSV of [Reports][reports]
306+
307+
200 Success Response:
308+
309+
See [Bulk Responses](#bulk-responses)
310+
311+
#### Reports Register Errors:
312+
313+
| `error` | `error_description` | `error_details`[] |
314+
| -------------------- | ------------------------------------------------- | ------------------------------- |
315+
| `bad_param` | A validation error occurred | Array of parameters with errors |
316+
| `missing_param` | A required parameter is missing | Array of missing parameters |
317+
| `already_registered` | A stop with `stop_id` is already registered | |
318+
319+
403 Unauthorized Response:
320+
321+
**None**
322+
323+
[Top][toc]
324+
290325
[accessibility-options]: /general-information.md#accessibility-options
291326
[beta]: /general-information.md#beta-features
292327
[bulk-responses]: /general-information.md#bulk-responses
@@ -295,15 +330,16 @@ If `stop_id` is specified, `GET` will return an array with a single stop record,
295330
[error-messages]: /general-information.md#error-messages
296331
[hdop]: https://en.wikipedia.org/wiki/Dilution_of_precision_(navigation)
297332
[modes]: /modes/README.md
298-
[propulsion-types]: /general-information.md#propulsion-types
333+
[propulsion-types]: /data_types.md#propulsion-types
334+
[reports]: /data_types.md#reports
299335
[responses]: /general-information.md#responses
300-
[stops]: /general-information.md#stops
301-
[telemetry-data]: /general-information.md#telemetry-data
302-
[trip-data]: /general-information.md#trips
336+
[stops]: /data_types.md#stops
337+
[telemetry-data]: /data_types.md#telemetry
338+
[trip-data]: /data_types.md#trips
303339
[toc]: #table-of-contents
304340
[ts]: /general-information.md#timestamps
305341
[vehicle]: /data-types.md#vehicles
306-
[vehicle-types]: /general-information.md#vehicle-types
342+
[vehicle-types]: /data_types.md#vehicle-types
307343
[vehicle-states]: /modes/vehicle_states.md
308344
[vehicle-event-types]: /modes/event_types.md
309345
[vehicle-event]: /data-types.md#events

0 commit comments

Comments
 (0)