Content
Authored content: courses and downloads, their structure and delivery
List courses
Requires `courses:read`. Every course in the organization, drafts included, filtered by status and category and searched by title.
Create a course
Requires `courses:write`. The course starts as a draft. 409 when its slug is taken.
Get a course
Requires `courses:read`.
Update a course
Requires `courses:write`. Changes only the fields sent. `thumbnailAssetId` must be a ready library image (409 otherwise); null clears it. A file it does not already use must be uploaded for it, or the caller needs `media:read` (403 otherwise).
Delete a course
Requires `courses:delete`.
Update a course's settings
Requires `courses:write`. Merges the settings sent into the current ones.
List downloads
Requires `downloads:read`. Every download, drafts included, filtered by status and category and searched by title.
Create a download
Requires `downloads:write`. The download starts as a draft. 409 when its slug is taken.
Get a download
Requires `downloads:read`.
Update a download
Requires `downloads:write`. Changes only the fields sent. `thumbnailAssetId` must be a ready library image (409 otherwise); null clears it. A file it does not already use must be uploaded for it, or the caller needs `media:read` (403 otherwise).
Delete a download
Requires `downloads:delete`. Its library files survive.
List a download's files in order
Requires `downloads:read`.
Add a library file to a download
Requires `downloads:write`. Added last. 409 when the file is not a ready library file or is already in the download. A file not uploaded for the download needs `media:read` (403 otherwise). Returns the download's files.
Reorder a download's files
Requires `downloads:write`. Send every file id of the download exactly once (409 otherwise). Returns the download's files.
Set a file's display name within a download
Requires `downloads:write`. Null falls back to the filename. Returns the download's files.
Remove a file from a download
Requires `downloads:write`. The library file itself survives. Returns the download's files.
List bundles
Requires `bundles:read`.
Create a bundle, optionally with initial content
Requires `bundles:write`. 404 when an initial content id is unknown.
Get a bundle
Requires `bundles:read`.
Rename a bundle
Requires `bundles:write`.
Delete a bundle
Requires `bundles:delete`. Its content survives; access granted through the bundle ends.
List a bundle's content
Requires `bundles:read`.
Add content to a bundle
Requires `bundles:write`. Everyone who holds the bundle can open the content from then on. Returns the bundle's content.
Remove content from a bundle
Requires `bundles:write`. The content survives; access to it through the bundle ends. Returns the bundle's content.
List the courses you can open
For a member of the organization. Published courses you hold, directly or through a bundle.
Get one course you can open
For a member of the organization who holds the course, or holds `courses:read` on it (which also opens it unpublished). 404 otherwise.
List the modules and activities of a course you can open
For a member of the organization who holds the course, or holds `courses:read` on it. Published activities only. 404 otherwise.
List the published activities of a course you can open
For a member of the organization who holds the course, or holds `courses:read` on it. 404 otherwise.
List the downloads you can open
For a member of the organization. Published downloads you hold, directly or through a bundle.
One download you can open, with its files in order
For a member of the organization who holds the download, or holds `downloads:read` on it (which also opens it unpublished). 404 otherwise.
List a course's modules
Requires `courses:read`. Modules in order, each with its activities.
Add a module
Requires `courses:write`. Added last. Returns the course's modules.
List a course's activities
Requires `courses:read`. Every activity, published or not.
List the library files each activity of a course uses
Requires `courses:read`. One row per activity and file, as recorded when the activity was saved.
Reorder a course's modules
Requires `courses:write`. Ids that are not modules of the course are ignored. Returns the course's modules.
Rename a module
Requires `courses:write`. Returns the course's modules.
Delete a module
Requires `courses:write`. Returns the course's modules.
Reorder the activities in a module
Requires `courses:write`. Send every activity id of the module once (409 otherwise). Returns the course's modules.
Add an activity
Requires `courses:write`. Records the library files the activity uses; each must be a ready library file (409 otherwise). A file the course does not already use must be uploaded for the course, or the caller needs `media:read` (403 otherwise). Returns the course's modules.
Update an activity
Requires `courses:write`. Replaces its content and records the library files it uses; each must be a ready library file (409 otherwise). A file the course does not already use must be uploaded for the course, or the caller needs `media:read` (403 otherwise). Returns the course's modules.
Delete an activity
Requires `courses:write`. Returns the course's modules.