enroll_user_in_course: Enroll a User in a Course

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

Description

This function is used to enroll a user in a specific course. Enrollment-settings can be altered, such as silent or invited enrollment and teacher or student enrollment.

This function is used to enroll a user in a specific course. Enrollment-settings can be altered, such as silent or invited enrollment and teacher or student enrollment.

Usage

enroll_user_in_course(
  course_id,
  user_id,
  enrollment_type = NULL,
  enrollment_state = NULL,
  course_section_id = NULL,
  interaction_limit = FALSE
)

enroll_user_in_course(
  course_id,
  user_id,
  enrollment_type = NULL,
  enrollment_state = NULL,
  course_section_id = NULL,
  interaction_limit = FALSE
)

Arguments

course_id	the course id (integer)
user_id	the canvas id of the user (string). Alternatively, the sis_id can be used by setting "sis_login_id:" in front of the sis_id.
enrollment_type	the type of the enrollment (string). Allowed values are "StudentEnrolment", "TeacherEnrollment", "TaEnrollment", ObserverEnrollment" and "DesignerEnrollment".
enrollment_state	the state of the enrollment (string). Allowed values are "active", "invited" and "inactive". Default is invited. N.B. if this parameter is incorrectly specified, the default is used.
course_section_id	the id of the section for the enrollment. Can be located in the URL when visiting the section page in the browser.
interaction_limit	limit interaction with users to section only.

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

enroll_user_in_course(course_id = 1867, user_id = "sis_login_id:pbosman", enrollment_type = "TeacherEnrollment", enrollment_state = "inactive")


enroll_user_in_course(course_id = 1867, user_id = "sis_login_id:pbosman", enrollment_type = "TeacherEnrollment", enrollment_state = "inactive")

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