evaluations: Evaluations

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

Description

Retrieve details of users' evaluations.

Usage

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

fac_get_evaluations_search(title, process_id, unit_id, self_evaluation,
  template_flag = seq(0, 2, 1), ...)

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.
title	string The title assigned to the evaluation
process_id	integer The process id associated with the evaluation process in which the evaluation resides.
unit_id	integer The unit id associated with the unit in which the evaluation resides.
self_evaluation	logical When true, the serach will be limited to self_evaluations.
template_flag	integer Retrieve evaluations that are not templates by using 0. Evaluations that are templates * with a value of 1, or evaluations that are workflow templates with a value of 2.

Value

a response object

Note

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

Examples

## Not run: 
## retrieves details for users' evaluations
r <- fac_get_evaluations(data = "detailed")
content(r)

## searches for an existing evaluation
r <- fac_get_evaluations_search()
content(r)

## End(Not run)

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