createEnrollment: Create Enrollment

View source: R/EnrollmentFunctions.R

createEnrollmentR Documentation

Create Enrollment

Description

This function modifies one or more attributes of a enrollment.

Usage

createEnrollment(realm, realm_id, uid, admin, status)

Arguments

realm

One of 'schools', 'buildings', 'users', 'groups', 'courses', or 'sections'.

realm_id

The id of the realm object.

uid

The Schoology ID of the user.

admin

Whether this user is an administrator (e.g. teacher) as opposed to a regular member (e.g. student)

status

The current status of the enrollment. 1: Active, 2: Expired (i.e. past course), 3: Invite pending, 4: Request Pending, 5: Archived (Course specific status members can be placed in before being fully unenrolled)

Value

A dataframe of updated enrollment details.

References

API Documentation


sterfa02/SchoologyAPI documentation built on Jan. 10, 2023, 11:27 p.m.