Skip to content

Latest commit

 

History

History
40 lines (35 loc) · 3.71 KB

Event.md

File metadata and controls

40 lines (35 loc) · 3.71 KB

# 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 int Event Type, as defined here: https://github.com/the-blue-alliance/the-blue-alliance/blob/master/consts/event_type.py#L2
district \TBAAPI\v3client\TBAAPI\v3client\model\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 \DateTime Event start date in `yyyy-mm-dd` format.
end_date \DateTime Event end date in `yyyy-mm-dd` format.
year int 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 int 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 double Latitude for the event address. [optional]
lng double 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 \TBAAPI\v3client\TBAAPI\v3client\model\Webcast[] [optional]
division_keys 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 int 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]

[Back to Model list] [Back to API list] [Back to README]