terms: Terms

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

Description

Retrieve details of academic terms.

Usage

fac_get_terms(yearlist, data = c("count", "summary", "detailed"), q,
  limit, offset, ...)

Arguments

yearlist	comma separated vector of integers Retrieve a term by year. When defined, filters terms matching the specified year to the term's academic year. When undefined, terms are not filtered by academic year. Multiple values can be sent as a comma separated list.
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.

Value

a response object

Note

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

Examples

## Not run: 
## retrieves the "term" periods that a school has set up
r <- fac_get_terms(data = "detailed")
content(r)

## retrieves the "term" periods that a school has set up
r <- fac_get_terms(data = "detailed", yearlist = "2017,2018")
content(r)

## End(Not run)

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