fac_get: Faculty180 GET

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

Description

Base function to perform any HMAC GET request.

Usage

fac_get(request_string, query = list(), ...,
  host = Sys.getenv("FAC180_BASE_URL"),
  credentials = fac_credentials(), data = c("count", "summary",
  "detailed"), q, limit, offset)

Arguments

request_string	string API endpoint to call
query	named list Passed to modify_url to build query strings.
...	additional arguments passed to GET.
host	string Host url
credentials	function Returns named list of credentials. See fac_credentials
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.

Value

a response object

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