makeRequest: Perform API Request to Endpoint

View source: R/AuthenticationFunctions.R

makeRequestR Documentation

Perform API Request to Endpoint

Description

This function performs an HTTP request to a Schoology API endpoint.

Usage

makeRequest(endpt, paramsList = NULL, verb = "GET", payload = NULL)

Arguments

endpt

The endpoint URL for the request.

paramsList

A list of parameters primarily used as searchFields.

verb

An HTTP request, either GET, PUT, POST or DELETE.

payload

A json object used in PUT and POST requests.
Use fromJSON(toJSON({yourNamedList}, pretty = T)).

Details

This function is called by all Schoology SDK functions. You will, in general, not need to call this function directly.

Value

The content of the request response.

References

Schoology Rest API Documentation


sterfa02/SchoologyAPI documentation built on Jan. 10, 2023, 11:27 p.m.