GET /reports/courses/
Description
Generates course report for course-id.
Endpoints
GET /reports/courses/{course-id}/
GET /reports/courses/{course-id}/page{#}/
GET /reports/courses/{course-id}/count/
Parameters
user_filter : (user-search-phrase) as described here
status : (string)
min_progress : (int) 0 - 100
max_progress : (int) 0 - 100
min_score : (int) 0 - 100
max_score : (int) 0 - 100
min_start_date : (date8)
max_start_date : (date8)
min_completion_date : (date8)
max_completion_date : (date8)
Notes
- No parameters are required - all paramters are optional
- If no parameters are sent, all users in
course-id will be returned
- Users in report are limited to those who are currently enrolled.
- These endpoints return paginated results, therefore having
/page{#}/ and /count/ endpoint variants to read and control the results delivered
- valid values for
status are passed, failed, complete or incomplete
Returns user_id, username, status, progress, score, start_date, completion_date for specified course-id.
[
{
"user_id": "2",
"username": "gregory0429",
"status": "incomplete",
"progress": "0",
"score": "0",
"start_date": "20210429",
"completion_date": ""
},
{
"user_id": "3",
"username": "adn9776",
"status": "incomplete",
"progress": "5",
"score": "0",
"start_date": "20200612",
"completion_date": ""
}
]
Description
Generates course report for course-id.
Endpoints
GET /reports/courses/{course-id}/GET /reports/courses/{course-id}/page{#}/GET /reports/courses/{course-id}/count/
Parameters
user_filter : (user-search-phrase) as described here
status : (string)
min_progress : (int) 0 - 100
max_progress : (int) 0 - 100
min_score : (int) 0 - 100
max_score : (int) 0 - 100
min_start_date : (date8)
max_start_date : (date8)
min_completion_date : (date8)
max_completion_date : (date8)
Notes
- No parameters are required - all paramters are optional
- If no parameters are sent, all users in
course-idwill be returned - Users in report are limited to those who are currently enrolled.
- These endpoints return paginated results, therefore having
/page{#}/and/count/endpoint variants to read and control the results delivered - valid values for
statusarepassed,failed,completeorincomplete
Returns user_id, username, status, progress, score, start_date, completion_date for specified course-id.
[ { "user_id": "2", "username": "gregory0429", "status": "incomplete", "progress": "0", "score": "0", "start_date": "20210429", "completion_date": "" }, { "user_id": "3", "username": "adn9776", "status": "incomplete", "progress": "5", "score": "0", "start_date": "20200612", "completion_date": "" }]