delete_section_enrollments: Delete section enrollments

In ICTO-FMG/uvacanvas: Utility Functions for ICTO-FMG for CANVAS API

Description

Deletes a specified section_enrollment from a section in a course. This does not mean a user will be unenrolled from the course, only from the section. You are able to either conclude, delete, inactivate or deactivate the enrollment.

Deletes a specified section_enrollment from a section in a course. This does not mean a user will be unenrolled from the course, only from the section. You are able to either conclude, delete, inactivate or deactivate the enrollment.

Usage

delete_section_enrollments(course_id, enrollment_id, task)

delete_section_enrollments(course_id, enrollment_id, task)

Arguments

course_id	the canvas id of the course (integer)
enrollment_id	the canvas user_id of the section enrollment (integer)
task	action to take on the enrollment "conclude", "delete", "inactivate" or "deactive" (character)

Value

server response. Either 200 status code if everything went correctly or a specific http status warning.

server response. Either 200 status code if everything went correctly or a specific http status warning.

Examples

 delete_section_enrollments(6348, 12345, "delete")

 delete_section_enrollments(6348, 12345, "delete")

ICTO-FMG/uvacanvas documentation built on Jan. 24, 2022, 5:16 a.m.