Description Usage Arguments Value Note Examples
Create & retrieve details of academic units.
1 2 3 4 5 |
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 |
a response
object
API documentation: https://faculty180.interfolio.com/swagger/ui/#tag/Units
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | ## 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)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.