courses: Courses

In Saint-Louis-University/fac180: R Bindings to Faculty180

Description

Retrieve details of Courses (Prefixes, Courses Taught, Attachments).

Usage

fac_get_course_prefixes(unitid, data = c("count", "summary", "detailed"),
  q, limit, offset, ...)

fac_get_courses(prefixes, extra = c("title", "description",
  "credithours", "lecturehours", "labhours", "extrahours",
  "extrahourslabel", "courselevel", "cipcode"), data = c("count",
  "summary", "detailed"), q, limit, offset, ...)

fac_get_courses_taught(termid, userlist, data = c("count", "summary",
  "detailed"), q, limit, offset, ...)

fac_get_courses_taught_id(coursestaughtid, termid, userlist,
  data = c("count", "summary", "detailed"), q, limit, offset, ...)

fac_get_courses_taught_id_attachment(coursestaughtid, data = c("count",
  "summary", "detailed"), q, limit, offset, ...)

Arguments

unitid	comma separated vector of integers When defined, filters for course with given course prefix. When undefined, all prefixes are returned.
data	string Determines the extent of data that will be returned. Count: Returns count of all activities found. Summary: Returns an array of sections and counts of activities within that section. Detailed: Returns an array of sections and a subarray of activityids for each section.
q	string Search term. Use '*' as wildcard.
limit	integer Limit query to specified number of records.
offset	integer Used with limit to return records in batches, e.g., if limit = 20 and offset = 21, records 21-40 will be returned.
...	additional arguments passed to GET.
prefixes	comma separated vector of string When defined, filters for course with given course prefix. When undefined, all prefixes are returned.
extra	comma separated vector of string When included, additional details are indexed and included in the returned array.
termid	string Value should match the termid of terms. When defined, filter courses that were taught during the specified term. When undefined, courses are not filtered by term.
userlist	comma separated vector of string Values should match the userid of users. When defined, filter returned courses by the specified users. When undefined, courses are not filtered by users
coursestaughtid	string Specify a coursestaughtid to retrieve details.

Value

a response object

Note

API documentation https://faculty180.interfolio.com/swagger/ui/#tag/Courses

Examples

## Not run: 
## retrieves course prefixes
r <- fac_get_course_prefixes()
content(r)

## retrieves course prefixes
r <- fac_get_course_prefixes(data = "detailed")
content(r)

## retrieves courses
r <- fac_get_courses()
content(r)

## retrieves courses
r <- fac_get_courses(data = "detailed", exta = "title,description")
content(r)

## retrieves details regarding the course catalog
r <- fac_get_courses_taught()
content(r)

## retrieves details regarding the course catalog
r <- fac_get_courses_taught(data = "detailed", termid = "2015/02")
content(r)

## retrieves details regarding a single item in the course catalog
r <- fac_get_courses_taught_id(coursestaughtid = 150)
content(r)

## retrieves details regarding a single item in the course catalog
r <- fac_get_courses_taught_id(coursestaughtid = 150, data = "detailed", termid = "2015/02")
content(r)

## retrieves details regarding the attachments of courses taught
r <- fac_get_courses_taught_id_attachment(coursestaughtid = 150)
content(r)

## retrieves details regarding the attachments of courses taught
r <- fac_get_courses_taught_id_attachment(coursestaughtid = 150)
content(r)

## End(Not run)

Saint-Louis-University/fac180 documentation built on Oct. 30, 2019, 11:46 p.m.