getCourses: Get courses from an account

In erikpal/bRush: R Canvas Instructure API Client

Get courses from an account

Description

Get course details for the provided account. All include parameters (syllabus_body, term, course_progress, storage_quota_used_mb, total_students, teachers) for this request have all been enabled and can be subsetted out if not needed.

Usage

getCourses(
  accountID,
  termID = NULL,
  search_term = NULL,
  by_teachers = NULL,
  by_subaccounts = NULL,
  type = NULL,
  server = "test",
  ...
)

Arguments

accountID	Integer of the account ID to find sub-accounts for
termID	Integer of enrollment term ID
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.
by_teachers	Vector of user ID integers.
by_subaccounts	Vector of subaccount integers.
type	Filter results to include course with at least one of specified string ("teacher","student","ta","observer","designer")
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.