V1::ReportsController
Reports
index
Get a list of school reports. This list is paginated and filtered if needed.
URL
GET /schools/:school_id/reportsObjeto resposta
| Array<Report> | The created reports. |
create
Create new report
URL
POST /schools/:school_id/reportsParâmetros obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| course_id | Integer | the course to build the report |
| school_id | Integer | the school to scope the report |
Parâmetros opcionais
| Nome | Tipo | Descrição |
|---|---|---|
| course_class_ids | Array | to filter the enrollments by course_class |
Objeto resposta
| report | The created report or the report's errors |
link
Get report's download url
URL
GET /reports/:id/linkParâmetros obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| id | Integer | of the report |
Objeto resposta
| Report | The requested report with the download url |
