course_classes_get
Lists classes or reads one class, its lessons, display date, description, cover or labels in the Course app (pApp C00007). Read only; changes go through the matching apply tool.
Inputs
| Field | Required here | Contract |
|---|---|---|
view |
No | one of: course-description, cover, publication-date, list, detail, labels, posts (by kind) |
view.seriesId |
Yes | When view.kind is course-description: integer; greater than 0 |
view.descriptionHtml |
Yes | When view.kind is course-description: string; max length 5000 |
view.inlineImages |
No | When view.kind is course-description: array; max items 100; default [] |
view.inlineImages[].token |
Yes | When view.kind is course-description: string; pattern ^[A-Za-z0-9_-]{1,80}$ |
view.inlineImages[].imageTaskId |
Yes | When view.kind is course-description: string; pattern ^[A-Za-z0-9_-]{8,80}$ |
view.seriesId |
Yes | When view.kind is cover: integer; greater than 0 |
view.change |
Yes | When view.kind is cover: one of: replace, restore (by kind) |
view.change.imageTaskId |
Yes | When view.kind is cover and view.change.kind is replace: string; pattern ^[A-Za-z0-9_-]{8,80}$ |
view.change.sourceTaskId |
Yes | When view.kind is cover and view.change.kind is restore: string; pattern ^[A-Za-z0-9_-]{8,80}$ |
view.seriesId |
Yes | When view.kind is publication-date: integer; greater than 0 |
view.query |
No | When view.kind is list: object; default {"page":1,"limit":15} |
view.query.page |
No | When view.kind is list: integer; minimum 1; maximum 10000; default 1 |
view.query.limit |
No | When view.kind is list: 15 or 30 or 50 or 100; default 15 |
view.query.search |
No | When view.kind is list: string; max length 200 |
view.query.isPublished |
No | When view.kind is list: boolean |
view.query.labelId |
No | When view.kind is list: integer; greater than 0 |
view.seriesId |
Yes | When view.kind is detail: integer; greater than 0 |
view.seriesId |
Yes | When view.kind is labels: integer; greater than 0 |
view.query |
No | When view.kind is posts: object; default {"page":1,"limit":15} |
view.query.page |
No | When view.kind is posts: integer; minimum 1; maximum 10000; default 1 |
view.query.limit |
No | When view.kind is posts: 15 or 30 or 50 or 100; default 15 |
view.query.search |
No | When view.kind is posts: string; max length 200 |
view.query.isPublished |
No | When view.kind is posts: boolean |