Skip to main content

External Training Modules

API endpoints related to External Training Modules.

GET /external_training_modules/current

Gets data for the current external training modules that have been approved by authors.

POST /external_training_modules/drafts

Gets data for the drafts of external training modules.

GET /external_training_modules/:id/usage

Get data for the places that a specified external training module has been used.

GET /external_training_modules/:id/player

Get data for playing an external training module. Requires a logged-in user assigned to a course containing the module

PUT /external_training_modules/:id/current

Promotes a specific import for a module to the 'current' version. The caller must have 'manage external training module permissions'. The specified import must be associated with the module.

PUT /external_training_modules/:id/draft

Sets a specific import for a module to the 'draft' version. The caller must have 'manage external training module permissions'. The specified import must be associated with the module.

GET /external_training_modules/:id/imports

Gets data for the import versions associated with an external training module. Sorted in descending order by the rustici_version_number

POST /external_training_modules/imports

First step in the process to import an external training module. Returns the ID of the imported external training module

POST /external_training_modules/imports/:importid/start/byUrl

Starts the upload process for an external module using a url. Requires import process to be started prior to calling this.

POST /external_training_modules/imports/:importid/start/byUpload

Starts the upload process for an external module using an uploaded file. Requires import process to be started prior to calling this.

POST /external_training_modules/imports/:importid/cancel

Cancels an in-progress import for an external training module.

GET /external_training_modules/imports/:importid/progress

Can be used for polling to get the progress of a running import. Should not be used to check the status of imports which have finished.

GET /external_training_modules/imports/:importid/preview

Returns player data for a preview of the specified module import

TRUSTe