units: Units

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

Description

Create & retrieve details of academic units.

Usage

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

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

Arguments

unitid	comma separated vector of integers Retrieve a unit with specific unitid(s). When defined, the unit specified and any sub-units are returned down the whole depth of the unit tree. When undefined, highest unit accessible and any sub-units are returned. 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.
depth	integer When defined, specifies how deep to recurse down the unit tree to find subunits.
...	additional arguments passed to GET.

Value

a response object

Note

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

Examples

## Not run: 
## retrieves a listing of academic units
r <- fac_get_units(data = "detailed")
content(r)

## retrieves a listing of academic units
r <- fac_get_units(data = "detailed", unitid = 2)
content(r)

## retrieves details on the specific unit
r <- fac_get_unit(unitid = 2, data = "detailed")
content(r)

## End(Not run)

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