Skip to content

Latest commit

 

History

History
75 lines (68 loc) · 5.03 KB

Event.md

File metadata and controls

75 lines (68 loc) · 5.03 KB

TBA API v3 Ruby Client::Event

Properties

Name Type Description Notes
key String TBA event key with the format yyyy[EVENT_CODE], where yyyy is the year, and EVENT_CODE is the event code of the event.
name String Official name of event on record either provided by FIRST or organizers of offseason event.
event_code String Event short code, as provided by FIRST.
event_type Integer Event Type, as defined here: https://github.com/the-blue-alliance/the-blue-alliance/blob/master/consts/event_type.py#L2
district DistrictList [optional]
city String City, town, village, etc. the event is located in. [optional]
state_prov String State or Province the event is located in. [optional]
country String Country the event is located in. [optional]
start_date Date Event start date in `yyyy-mm-dd` format.
end_date Date Event end date in `yyyy-mm-dd` format.
year Integer Year the event data is for.
short_name String Same as `name` but doesn't include event specifiers, such as 'Regional' or 'District'. May be null. [optional]
event_type_string String Event Type, eg Regional, District, or Offseason.
week Integer Week of the event relative to the first official season event, zero-indexed. Only valid for Regionals, Districts, and District Championships. Null otherwise. (Eg. A season with a week 0 'preseason' event does not count, and week 1 events will show 0 here. Seasons with a week 0.5 regional event will show week 0 for those event(s) and week 1 for week 1 events and so on.) [optional]
address String Address of the event's venue, if available. [optional]
postal_code String Postal code from the event address. [optional]
gmaps_place_id String Google Maps Place ID for the event address. [optional]
gmaps_url String Link to address location on Google Maps. [optional]
lat Float Latitude for the event address. [optional]
lng Float Longitude for the event address. [optional]
location_name String Name of the location at the address for the event, eg. Blue Alliance High School. [optional]
timezone String Timezone name. [optional]
website String The event's website, if any. [optional]
first_event_id String The FIRST internal Event ID, used to link to the event on the FRC webpage. [optional]
first_event_code String Public facing event code used by FIRST (on frc-events.firstinspires.org, for example) [optional]
webcasts Array<Webcast> [optional]
division_keys Array<String> An array of event keys for the divisions at this event. [optional]
parent_event_key String The TBA Event key that represents the event's parent. Used to link back to the event from a division event. It is also the inverse relation of `divison_keys`. [optional]
playoff_type Integer Playoff Type, as defined here: https://github.com/the-blue-alliance/the-blue-alliance/blob/master/consts/playoff_type.py#L4, or null. [optional]
playoff_type_string String String representation of the `playoff_type`, or null. [optional]

Code Sample

require 'TBA API v3 Ruby Client'

instance = TBA API v3 Ruby Client::Event.new(key: null,
                                 name: null,
                                 event_code: null,
                                 event_type: null,
                                 district: null,
                                 city: null,
                                 state_prov: null,
                                 country: null,
                                 start_date: null,
                                 end_date: null,
                                 year: null,
                                 short_name: null,
                                 event_type_string: null,
                                 week: null,
                                 address: null,
                                 postal_code: null,
                                 gmaps_place_id: null,
                                 gmaps_url: null,
                                 lat: null,
                                 lng: null,
                                 location_name: null,
                                 timezone: null,
                                 website: null,
                                 first_event_id: null,
                                 first_event_code: null,
                                 webcasts: null,
                                 division_keys: null,
                                 parent_event_key: null,
                                 playoff_type: null,
                                 playoff_type_string: null)