teachboost_api: R API for TeachBoost's RESTful API

Description Usage Arguments Details Value

View source: R/teachboost_api.R

Description

R API for TeachBoost's RESTful API

Usage

1
teachboost_api(endpoint, key, parsed = FALSE, ...)

Arguments

endpoint

the endpoint from which data is requested

key

your organizaitons TeachBoost API token

parsed

wheterh the whether the response content should be parsed to a (possibly flattened) data.frame ('TRUE') or the whether the raw JSON us returned ('FALSE').

...

Not used

Details

This is a workhourse function that wraps the HTTP RESTful API that TeachBoos has implemented. You will need your API key, which you'll need to request from TeachBoost.

Value

a teadchboostr object, which is a list containing the response, endpoint path, and returned content


kippchicago/teachboostr documentation built on May 20, 2019, 10:23 a.m.