user_data: User Data

Description Usage Arguments Value Note Examples

Description

Retrieves a users activity information.

Usage

1
2
fac_get_user_data(unitid, sectionid, category, termstart, termfinish,
  userlist, q, limit, offset, ...)

Arguments

unitid

integer Retrieve a unit 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.

category

string Valid values are profile and activity_input. When defined, limits the sections to the specified form. When undefined, all sections are returned.

termstart

string Value should match the termid of terms. When defined, limits activities to the specified starting term. When undefined, the furthest back term is used.

termfinish

string Value should match the termid of terms. When defined, limits activities to the specified ending term. When undefined, defaults to the current term.

userlist

comma seperated vector of string Values should match the userid of users. When defined, filter returned data to the specified users. When undefined, all users are returned.

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/User-Data

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
## retrieves all of the user's activities with section information
r <- fac_get_user_data(userlist = "m123456,m789123")
content(r)

## retrieves all of the user's activities with section information
r <- fac_get_user_data(userlist = "m123456,m789123", category = "activity_input")
content(r)

## End(Not run)

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