| key |
kotlin.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 |
kotlin.String |
Official name of event on record either provided by FIRST or organizers of offseason event. |
|
| eventCode |
kotlin.String |
Event short code, as provided by FIRST. |
|
| eventType |
kotlin.Int |
Event Type, as defined here: https://github.com/the-blue-alliance/the-blue-alliance/blob/master/consts/event_type.py#L2 |
|
| startDate |
java.time.LocalDate |
Event start date in `yyyy-mm-dd` format. |
|
| endDate |
java.time.LocalDate |
Event end date in `yyyy-mm-dd` format. |
|
| year |
kotlin.Int |
Year the event data is for. |
|
| eventTypeString |
kotlin.String |
Event Type, eg Regional, District, or Offseason. |
|
| district |
DistrictList |
|
[optional] |
| city |
kotlin.String |
City, town, village, etc. the event is located in. |
[optional] |
| stateProv |
kotlin.String |
State or Province the event is located in. |
[optional] |
| country |
kotlin.String |
Country the event is located in. |
[optional] |
| shortName |
kotlin.String |
Same as `name` but doesn't include event specifiers, such as 'Regional' or 'District'. May be null. |
[optional] |
| week |
kotlin.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 |
kotlin.String |
Address of the event's venue, if available. |
[optional] |
| postalCode |
kotlin.String |
Postal code from the event address. |
[optional] |
| gmapsPlaceId |
kotlin.String |
Google Maps Place ID for the event address. |
[optional] |
| gmapsUrl |
kotlin.String |
Link to address location on Google Maps. |
[optional] |
| lat |
kotlin.Double |
Latitude for the event address. |
[optional] |
| lng |
kotlin.Double |
Longitude for the event address. |
[optional] |
| locationName |
kotlin.String |
Name of the location at the address for the event, eg. Blue Alliance High School. |
[optional] |
| timezone |
kotlin.String |
Timezone name. |
[optional] |
| website |
kotlin.String |
The event's website, if any. |
[optional] |
| firstEventId |
kotlin.String |
The FIRST internal Event ID, used to link to the event on the FRC webpage. |
[optional] |
| firstEventCode |
kotlin.String |
Public facing event code used by FIRST (on frc-events.firstinspires.org, for example) |
[optional] |
| webcasts |
kotlin.Array<Webcast> |
|
[optional] |
| divisionKeys |
kotlin.Array<kotlin.String> |
An array of event keys for the divisions at this event. |
[optional] |
| parentEventKey |
kotlin.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] |
| playoffType |
kotlin.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] |
| playoffTypeString |
kotlin.String |
String representation of the `playoff_type`, or null. |
[optional] |