GetDistricts: Get a list of FIRST districts

In irwinsnet/FIRST_api_R: Tools to Download and Convert FIRST API Data to R Data Frames

Description

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.

Usage

GetDistricts(session, mod_since = NULL, only_mod_since = NULL)

Arguments

session	A Session object created with GetSession().
mod_since	A character vector containing an HTTP formatted date and time. Returns NA if no changes have been made to the requested data since the date and time provided. Optional
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.

Details

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

Value

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.

Columns

1. code: character

2. name: character

3. districtCount: integer

See Also

Refer to Standard_attributes for data attributes returned by this function.

Examples

sn <- GetSession("username", "key")
districts <- GetDistricts(sn)

irwinsnet/FIRST_api_R documentation built on Dec. 22, 2020, 5:12 p.m.