users: Users

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

Description

Create, update and retrieve details of users.

Usage

fac_get_users(unitid, employmentstatus = c("All", "Full Time",
  "Part Time", "Staff", "Inactive", "All Active"), data = c("count",
  "summary", "detailed"), q, limit, offset, ...)

fac_get_user(userid, extra = c("accounttype", "suffix", "honorific",
  "officebuilding", "officenumber", "phone", "gender", "race",
  "nationality", "homephone", "homestreet1", "homestreet2", "homecity",
  "homestate", "homezipcode", "cellphone", "teachinginterest",
  "researchinterest", "rankname", "biography", "emergencycontact",
  "emergencycontactphone", "pager", "personalstreet1", "personalstreet2",
  "personalcity", "personalstate", "personalzip", "url"),
  data = c("count", "summary", "detailed"), q, limit, offset, ...)

fac_get_users_activity_input_request()

fac_get_users_current()

Arguments

unitid	comma separated vector of integers Retrieve a user with specific unitid(s) When defined, filters users with given unitid as their primary unit. When undefined, all users for all units are returned. Multiple values can be sent as a comma separated list.
employmentstatus	string When defined, users are filtered by their employment status.
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.
userid	string Retrieves full profile details on the specified user(s). By default the only data that is returned for a given user is basic identifying information, if other user details are needed they should be specified using the “extra” parameter.
extra	comma seperated vector of string Multiple values can be sent as a comma separated list. When included, additional details are indexed and included in the returned array.

Value

a response object

Note

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

Examples

## Not run: 
## retrieves a listing of users and basic identifying information for each
r <- fac_get_users(data = "detailed")
content(r)

## retrieves a listing of users and basic identifying information for each
r <- fac_get_users(data = "detailed", employmentstatus = "Full+Time")
content(r)

## retrieves full profile details on the specified user(s)
r <- fac_get_user(userid = "m123456")
content(r)

## retrieves full profile details on the specified user(s)
r <- fac_get_user(userid = "m123456", data = "detailed", extra = "honorific,phone, acounttype")
content(r)

## retrieves a list of active activity input requests
r <- fac_get_users_activity_input_request()
content(r)

## retrieves a list of tenant IDs and is_institutional_admin flag
r <- fac_get_users_current()
content(r)

## End(Not run)

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