Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Method: updateModulesStatuses

info
Panel
bgColor#eaf4fd

Note:

  • With this method, you can edit the status only of a content item that is included in a course. You won't be able to edit the status of a training included in a course using this method.

...

The Account OwnerAccount AdministratorsDepartment Administrators, or custom roles with the 'Can edit' access to the content item. 

Department Administrators and users with a custom role can edit the statuses of the modules assigned to the users belonging to the departments they manage and their sub-departments.

...

ParameterTypeDescription
token (required)stringAccess token. You can obtain a token by making a request.
enrollmentIds (required)stringThe IDs of one or more enrollments whose statuses you would like to update.
courseId (required)stringThe ID of the course to which one or more modules whose statuses you would like to update belong.
moduleStatuses (required)arrayAn array with the data regarding the module's status. 
contentItemId (required)stringThe ID of the module whose status you would like to update.
date (required)dateThe module completion date.
reason (optional)stringThe reason why you want to change the module's status.
status (required)string

The status you would like to assign to the module. 

Possible values:

  • сomplete
  • incomplete
  • passed
  • failed
  • accepted
  • declined
awardedScore (required)stringThe number of scores earned for the module completion.

...