faculty_classifications: Faculty Classifications

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

Description

Retrieve details of Faculty Classifications.

Usage

fac_get_faculty_classification_data(userlist, facultyclassificationlist,
  termstart, termfinish, data = c("count", "summary", "detailed"), q,
  limit, offset, ...)

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

fac_get_faculty_classification_class(facultyclassificationid,
  data = c("count", "summary", "detailed"), q, limit, offset, ...)

Arguments

userlist	comma separated vector of string Values should match the userid of users. When defined, filter returned data to the specified users. When undefined, all users are returned.
facultyclassificationlist	comma separated vector of integer Values should match the facultyclassificationid of faculty classifications. When defined, filter returned data to the specified faculty classifications. When undefined, all faculty classifications are returned.
termstart	string Value should match the termid of terms. When defined, limits classification data to the specified starting term. When undefined, defaults to the current term.
termfinish	string Value should match the termid of terms. When defined, limits classification data to the specified ending term. When undefined, defaults to the current term.
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.
unitid	integer Retrieve a faculty classification with a specific unitid. When defined, filters classifications to the specified unit. When undefined, filters classifications from the highest unit accessible.
facultyclassificationid	integer Retrieves details regarding a specific faculty classification.

Value

a response object

Note

API documentation: https://faculty180.interfolio.com/swagger/ui/#tag/Faculty-Classifications

Examples

## Not run: 
## retrieves details regarding faculty classifications values for prescribed faculty
r <- fac_get_faculty_classification_data()
content(r)

## retrieves details regarding faculty classifications values for prescribed faculty
r <- fac_get_faculty_classification_data(userlist = "m123456", data = "detailed")
content(r)

## retrieves details regarding faculty classifications
r <- fac_get_faculty_classifications()
content(r)

## retrieves details regarding faculty classifications
r <- fac_get_faculty_classifications(unitid = 2, data = "detailed")
content(r)

## retrieves details regarding a specific faculty classification
r <- fac_get_faculty_classification_class(facultyclassificationid = -2, data = "detailed")
content(r)

## End(Not run)

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