course_students_get
Reads enrolled students, one student's classes or their lesson progress in the Course app (pApp C00007). Read only.
Inputs
| Field | Required here | Contract |
|---|---|---|
view |
Yes | one of: students, student-classes, student-sessions (by kind) |
view.query |
No | When view.kind is students: object; default {"page":1,"limit":15} |
view.query.page |
No | When view.kind is students: integer; minimum 1; maximum 10000; default 1 |
view.query.limit |
No | When view.kind is students: 15 or 30 or 50 or 100; default 15 |
view.query.search |
No | When view.kind is students: string; max length 200; pattern ^[^\x00-\x1f\x7f]*$ |
view.studentId |
Yes | When view.kind is student-classes: integer; greater than 0 |
view.studentsQuery |
No | When view.kind is student-classes: object; default {"page":1,"limit":15}; The student list page (page, limit, search) where studentId was returned. |
view.studentsQuery.page |
No | When view.kind is student-classes: integer; minimum 1; maximum 10000; default 1 |
view.studentsQuery.limit |
No | When view.kind is student-classes: 15 or 30 or 50 or 100; default 15 |
view.studentsQuery.search |
No | When view.kind is student-classes: string; max length 200; pattern ^[^\x00-\x1f\x7f]*$ |
view.query |
No | When view.kind is student-classes: object; default {"page":1,"limit":15} |
view.query.page |
No | When view.kind is student-classes: integer; minimum 1; maximum 10000; default 1 |
view.query.limit |
No | When view.kind is student-classes: 15 or 30 or 50 or 100; default 15 |
view.studentId |
Yes | When view.kind is student-sessions: integer; greater than 0 |
view.studentsQuery |
No | When view.kind is student-sessions: object; default {"page":1,"limit":15}; The student list page (page, limit, search) where studentId was returned. |
view.studentsQuery.page |
No | When view.kind is student-sessions: integer; minimum 1; maximum 10000; default 1 |
view.studentsQuery.limit |
No | When view.kind is student-sessions: 15 or 30 or 50 or 100; default 15 |
view.studentsQuery.search |
No | When view.kind is student-sessions: string; max length 200; pattern ^[^\x00-\x1f\x7f]*$ |
view.seriesId |
Yes | When view.kind is student-sessions: integer; greater than 0 |
view.query |
No | When view.kind is student-sessions: object; default {"page":1,"limit":15} |
view.query.page |
No | When view.kind is student-sessions: integer; minimum 1; maximum 10000; default 1 |
view.query.limit |
No | When view.kind is student-sessions: 15 or 30 or 50 or 100; default 15 |