processRequest: Get Multipage Results

In erikpal/bRush: R Canvas Instructure API Client

Get Multipage Results

Description

Takes a url constructed for API request, including url parameters to produce one result from multiple requests across multiple pages. The parameters of this function, most likely passed from others, can be used to narrow the results by start and end page, as well as the number of results per page (max. 100).

Usage

processRequest(
  url,
  body,
  method = "GET",
  env_var_name = "CanvasApiKey",
  as_user_id = NULL,
  verbose = FALSE
)

Arguments

env_var_name	Name of the API key saved in .Renviron
as_user_id	User id for masquerading
verbose	Enable verbose mode
per_page	Number of results requested at one time (max: 100)
page	Page number to start requests from
end_page	Page number to end requests

erikpal/bRush documentation built on May 9, 2023, 8:27 p.m.