sections: Sections

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

Description

Retrieve details of Sections.

Usage

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

fac_get_section(sectionid, data = c("count", "summary", "detailed"), q,
  limit, offset, ...)

Arguments

unitid	integer Retrieve a section with a specific unitid. When defined, sections are limited to those found at the specified unit. When undefined, all sections are returned.
sectionid	integer Retrieve a section with a specific sectionid. When defined, limits the sections to only the specified section. When undefined, all sections are returned
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/Sections

Examples

## Not run: 
## retrieves data sections
r <- fac_get_sections()
content(r)

# retrieves data sections
r <- fac_get_sections(sectionid = 5, data = "summary")
content(r)

## retrieves information on a specific section
r <- fac_get_section(sectionid = -15)
content(r)

# retrieves information on a specific section
r <- fac_get_section(sectionid = -15, data = "summary")
content(r)

## End(Not run)

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