Skip to content

Latest commit

 

History

History
44 lines (39 loc) · 4.21 KB

Event.md

File metadata and controls

44 lines (39 loc) · 4.21 KB
Raw

tba_api_client.model.Event

Load the model package

import 'package:tba_api_client/api.dart';

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

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