Generate a bussing report

POST

https://ssuccessv2.com/app/api/v1/bussing/reporting-export/reports

POST

/app/api/v1/bussing/reporting-export/reports

$ curl -X POST https://ssuccessv2.com/app/api/v1/bussing/reporting-export/reports \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "report_type": "students_by_route",
>   "start_date": {},
>   "end_date": {}
> }'

1 {
2   "status": "success",
3   "message": "",
4   "data": [
5     {
6       "trip_date": {},
7       "route_number": 12,
8       "run_name": "Morning Route",
9       "bus_name": "Bus 4",
10       "driver_name": "Marcus Johnson",
11       "stop_number": 3,
12       "stop_name": "Oak Street",
13       "student_grade": "Grade 4",
14       "stop_address": "18 Beacon Street, Boston, MA 02108",
15       "stop_type": "bus_change",
16       "scheduled_time": "07:42:00",
17       "actual_time": {}
18     }
19   ]
20 }

Generates bus changes, students-by-route, or route-stop-history data for the supplied ISO-8601 date range.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Request

This endpoint expects an object.

report_typeenumRequired

Allowed values:

start_datedatetimeRequired

end_datedatetimeRequired

Response

Report rows generated.

statusstringOptional

messagestringOptional

datalist of maps from strings to anyOptional

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error