GetServerStatus: Get the status of the FIRST API server

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

Description

See the API Index section of the FIRST API documentation at http://docs.frcevents2.apiary.io/# for more details.

Usage

GetServerStatus(session)

Arguments

session

A Session object created with GetSession().

Details

The FIRST API URL format is:

https://frc-api.firstinspires.org/v2.0

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, "Status").

Columns

1. name: character

2. version: double

3. status: character

Attributes

• url: Character vector containing URL submitted to FIRST API server.

• local_test_data: TRUE if data was extracted from R/sysdata.rda file.

• local_url: Character vector containing URL used to download local data.

• time_downloaded: Character vector containing the local system time that the object was downladed from the FIRST API server. Formatted an an http date and time string.

• last_modified: Character vector containing the date and time that the data was last modified by the FIRST API server.

Examples

sn <- GetSession("username", "key")
status <- GetServerStatus(sn)

irwinsnet/firstapiR documentation built on Dec. 22, 2020, 5:13 p.m.