getCourseUsers: Get users from a course

In erikpal/bRush: R Canvas Instructure API Client

Get users from a course

Description

Get user details for the provided course. Most include parameters ("email", "enrollments","locked","avatar_url","bio") for this request have all been enabled and can be subsetted out if not needed. This excludes "test_student," which has been set to its own argument.

Usage

getCourseUsers(
  courseID,
  search_term = NULL,
  user_ids = NULL,
  test_student = FALSE,
  type = NULL,
  role_id = NULL,
  state = NULL,
  server = "test",
  ...
)

Arguments

courseID	Course ID to find users for
search_term	Filter results by partial course name, code, or full ID to match and return in the results list. Must be at least 3 characters.
user_ids	Vector of user IDs to limit results by
test_student	Boolean to include test student in results
type	Filter results to include user with at least one of specified string ("teacher","student","ta","observer","designer")
role_id	Integer of role to limit results (SIS ID not supported)
state	Filter results to include only users with one of specified string ("active","invited","rejected","completed","inactive")
server	Test, beta, production, or other name in R.environ OR full url of server
...	Optional page options to pass to processRequest

erikpal/bRush documentation built on May 9, 2023, 8:27 p.m.