Update course status

Method

Method Description
course.courseUpdateStatus Update course status.

Request parameters

{
    "id": {CourseId},
    "ignore_warnings": {IgnoreWarnings},
    "ready": {Ready}
}

Response parameters

{
    "completed": {Comleted}
}

Variable Type Appearance Description
{CourseId} Integer Mandatory Course id.
{IgnoreWarnings} Boolean Optional Setting {Ready} to true triggers a full assessment check of the course. If the check finds issues, they are returned as warnings in the response and {CourseStatus} is not updated to "completed". Review the warnings and fix them where possible. Set this to true to mark the course as completed anyway, disregarding the warnings. Has no effect when {Ready} is false or when the check finds no warnings.
{Ready} Boolean Mandatory Indicates status of course:
  • true - Course is completed and can be used
  • false - Course is not finished and is in process of modification
Please be aware that any modification to any part of course will reset its status to false.
Marking as true also requires at least 1 learning page(s) and a non-empty course description (see Course: create/update).
{Completed} Boolean Mandatory Indicates whether action was successfully completed or not.