R/getQuizzes.R

In erikpal/bRush: R Canvas Instructure API Client

#' Get quizzes from a course
#' 
#' Get quizzes for the provided course.
#' @param courseID Course ID to find quizzes for
#' @param search_term Filter results by partial course name, code, or full ID to match and return in the results list. Must be at least 3 characters.
#' @param server Test, beta, production, or other name in R.environ OR full url of server
#' @export

getQuizzes <- function(courseID, search_term = NULL, server = "test", ...) {

        url <- loadURL(server)
        
        url$path <- "api/v1/courses/courseID/quizzes"
        url$path <- sub("courseID", courseID, url$path)
        
        url$query <- list(search_term = search_term)
        
        if (!is.null(search_term)) {
                if (nchar(search_term) < 2) {
                        warning("Search term must be three or more characters.")
                }
        }
        
        ##Pass the url to the request processor
        results <- processRequest(url, ...)
        
        return(results)
}