tenant configuration

post

Bulk set configuration settings via POST request. If explicit is not set, then just ensure the effective value of this setting is as specified. If explicit is set, then actually record the specified value at this level, even if it already would have effectively had this value due to a default or lower level setting.

get

Returns the effective values for all configuration settings associated with the parent resource.

put

Sets the value for this configuration setting, for the resource being configured.

get

Returns the effective value for this configuration setting for the resource being configured.

courses

Import, list, or delete courses.

get

Get the list of courses

delete

Delete the course with courseId = {courseId}

get

Get courses based on courseId

get

gets the last version ID that exists for this course

put

Sets the course title for the specified course

get

get the course title

get

Returns the launch link to use to preview this course

get

Returns xAPI activity ID associated with this course

post

Bulk set configuration settings via POST request. If explicit is not set, then just ensure the effective value of this setting is as specified. If explicit is set, then actually record the specified value at this level, even if it already would have effectively had this value due to a default or lower level setting.

get

Returns the effective values for all configuration settings associated with the parent resource.

put

Sets the value for this configuration setting, for the resource being configured.

get

Returns the effective value for this configuration setting for the resource being configured.

post

Either the actual contents of the zip file to import may be posted, or JSON that references the remote location to import from. Note that parameters common to both modes must be specified on the querystring. An import job will be started to import the posted or referenced file, and the import job ID will be returned. If the import is successful, the imported course will be registered using the courseId provided.

get

This method will check the status of an import job.

registrations

Create, list, or delete registrations.

post

Create a registration. The application/json format should be used, the application/x-www-form-urlencoded is available for compatibiliy with older systems.

get

Gets a list of registrations including a summary of the status of each registration. Note the "since" parameter exists to allow retreiving only registrations that have changed, and the "before" parameter exists to allow retreiving only registrations that haven't changed

get

Gets the number of registrations, optionally for the specified course ID

delete

Delete the registration with registrationId = {registrationId}

get

Does this registration exist?

get

Get all the instances of this the registration specified by the registration ID

post

Bulk set configuration settings via POST request. If explicit is not set, then just ensure the effective value of this setting is as specified. If explicit is set, then actually record the specified value at this level, even if it already would have effectively had this value due to a default or lower level setting.

get

Returns the effective values for all configuration settings associated with the parent resource.

put

Sets the value for this configuration setting, for the resource being configured.

get

Returns the effective value for this configuration setting for the resource being configured.

get

Returns xAPI registration ID associated with this registration

get

gets the last instance ID that exists for this registration

delete

delete registration progress (clear registration)

get

Get registration summary

get

Get detailed registration progress. Note: the data returned is the same as for /progress, except that 'activityDetails' is populated where applicable

delete

delete global data associated with this registration

xAPI credentials

Create, list, or delete xAPI credentials.

post

Create an xAPI credentials.

get

Get the list of xapiCredentials

put

Edit an existing xAPI credential or create a new one, specified by the xAPI credentials id

delete

Deletes the xAPI credentials specified by the xAPI credentials id

get

Retrieves the xAPI credentials specified by the xAPI credentials id

xapiPipes

Create, list, or delete xAPI pipes.

post

Create an xAPI pipe.

get

Get the list of xapiPipes

put

Edit an existing xAPI pipe or create a new one. Editing a pipe will cause it to start over and forward any statements it finds, even if the prior version of the pipe had already forwarded those statements. Note: if the pipe being edited is currently being processed, the this request will fail with a status code of 409.

delete

Deletes this xAPI pipe. Caution: avoid re-creating a pipe with the same ID quickly after a delete. The old version could still be processing, in which case the new pipe could be updated improperly by the processor.

get

Retrieves this xAPI pipe

ping

get

Get back a message indicating that the API is working.