Description Usage Arguments Details Value Columns See Also Examples
View source: R/firstapiR_main.R
This function returns a list of all current districs, including their titles and codes. District codes are used as parameters for several other FIRST API functions.
1 | GetDistricts(session, mod_since = NULL, only_mod_since = NULL)
|
session |
A Session object created with |
mod_since |
A character vector containing an HTTP formatted date and
time. Returns |
only_mod_since |
A character vector containing an HTTP formatted date and time. This function only returns data that has changed since the date and time provided. Optional. |
See the District Listings section of the FIRST API documentation at http://docs.frcevents2.apiary.io/# for more details.
The FIRST API URL format is:
https://frc-api.firstinspires.org/v2.0/season/districts
Depending on the session$format
value, returns JSON text, an
XML::XMLDocument object, or a data.frame with class set to c("data.frame,
"Districts"). Returns a logical vector of length one with value NA
if data is unchanged since date and time passed in arguments
mod_since
or only_mod_since
.
code: character
name: character
districtCount: integer
Refer to Standard_attributes
for data
attributes returned by this function.
1 2 | sn <- GetSession("username", "key")
districts <- GetDistricts(sn)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.