Andal.LND/edx-platform
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

EDUCATOR-3622 | Add a username_contains query param to gradebook endpoint

Browse Source
This commit is contained in:
Alex Dusenbery
2018-10-26 11:47:44 -04:00
committed by Alex Dusenbery
parent c02b195ff7
commit b528b8e5d7
3 changed files with 105 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
lms/djangoapps/grades/docs/decisions/0001-gradebook-api.rst
View File

@@ -28,8 +28,10 @@ Decisions
#. **The read (GET) API**
a. The read API supports either fetching subsection scores for a single user, by `username`, or fetching
a paginated result of subsection grade data for all enrollees in the requested course.
a. The read API supports either fetching subsection scores for a single user via ``?username=my-user-name``,
where we look up a user by their exact ``username`` value; via ``?username_contains=name-substring`` where
we do a case-insensitive substring query for a user, or fetching a paginated result of
subsection grade data for all enrollees in the requested course.
b. We will use the data schema required by the EE's front-end implementation. This will allow us to port
over much of EE's front-end code with only minor modifications. Note that there are some fields specified