vitas: Vitas

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

Description

Retrieve details of users' vitaes.

Usage

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

fac_get_vita(vitaid, userid, termstart, termfinish, output = c("json",
  "html", "html_clean"), q, limit, offset, ...)

fac_get_vita_templates(tenant_id, search_text, limit, page, sort_by,
  descending, pid, ...)

Arguments

unitid	integer Enter a unitid to retrieve evaluation data from that specific unit. When defined, filter evaluations to the specified unit. When undefined, filters evaluations 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.
vitaid	integer Retrieves details for the specified vitae.
userid	string Retrieves details on the specified user(s).
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.
output	string A list of Vitaes. If output=json Returns an array of values for the specified vitas, as well as enabled sections on the vita. If output=html Directly displays vita requested as an HTML document with Styling as it would display directly from the software. If output=html_clean Directly displays vita requested as an HTML document with: All inline styling from DATA180 default styling is removed. All styling from a user as supplied from rich text edited text is removed (this will be corrected in a later release to try to honor this styling). Styling applied to each scholarly work for formatting each scholarly citation with the appropriate citation style is retained.
tenant_id	integer Tenant associated with the request.
search_text	string Search term.
page	integer Limit query to specified page of records.
sort_by	string Sort the results by a desired column.
descending	logical When true, the sort column is sorted in descending order.
pid	integer User pid filter for the given request.

Value

a response object

Note

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

Examples

## Not run: 
## retrieves details of all vitae
r <- fac_get_vitas(data = "detailed")
content(r)

## retrieves details for a user's vita
r <- fac_get_vita(vitaid = 100,
                  userid = "m123456",
                  output = "html",
                  termstart = "2015/02",
                  termfinish = "2017/02")
content(r)

## End(Not run)

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