activity_classifications: Activity Classifications

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

Description

Retrieves details regarding activity classifications.

Usage

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

fac_get_activity_classification(activityclassificationid,
  data = c("count", "summary", "detailed"), q, limit, offset, ...)

Arguments

unitid	integer Retrieve an Activity Classification with a specific unitid. When defined, filter classifications to the specified unit. When undefined, filters classifications from the highest unit accessible.
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.
activityclassificationid	integer Retrieves a specific Activity Classification based on the activityclassificationid.

Value

a response object

Note

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

Examples

## Not run: 
## retrieves details regarding activity classifications
r <- fac_get_activity_classifications(data = "detailed")
content(r)

## retrieves details regarding activity classifications
r <- fac_get_activity_classifications(activityclassificationid = 18, data = "detailed")
content(r)

## End(Not run)

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