listEnrollments: List Enrollments for a Course

In sterfa02/SchoologyAPI: Creates R Functions for Schoology API Functions

List Enrollments for a Course

Description

This function returns a list of enrollments for a course past and present.

Usage

listEnrollments(
  realm,
  realm_id,
  uid = NULL,
  enrollment_status = NULL,
  type = NULL,
  picture_size = NULL
)

Arguments

realm	One of 'schools', 'buildings', 'users', 'groups', 'courses', or 'sections'.
realm_id	The id of the realm object.
uid	Filter enrollments for a given user.
enrollment_status	Filter enrollments for a given enrollment status 1-5.
type	Filter enrollments by an enrollment type. Possible values: 'admin' or 'member'.
picture_size	Specify size of profile picture returned with this user. Possible values: 'big', 'reg', 'sm', or 'tiny'.

Details

A enrollment is specific user assigned to the realm object.

Value

A dataframe of enrollment details.

References

API Documentation

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