EventApi.md

tba_api_v3.api.EventApi

Load the API package

import 'package:tba_api_v3/api.dart';

All URIs are relative to https://www.thebluealliance.com/api/v3

Method	HTTP request	Description
getDistrictEvents	GET /district/{district_key}/events
getDistrictEventsKeys	GET /district/{district_key}/events/keys
getDistrictEventsSimple	GET /district/{district_key}/events/simple
getEvent	GET /event/{event_key}
getEventAlliances	GET /event/{event_key}/alliances
getEventAwards	GET /event/{event_key}/awards
getEventDistrictPoints	GET /event/{event_key}/district_points
getEventInsights	GET /event/{event_key}/insights
getEventMatchTimeseries	GET /event/{event_key}/matches/timeseries
getEventMatches	GET /event/{event_key}/matches
getEventMatchesKeys	GET /event/{event_key}/matches/keys
getEventMatchesSimple	GET /event/{event_key}/matches/simple
getEventOPRs	GET /event/{event_key}/oprs
getEventPredictions	GET /event/{event_key}/predictions
getEventRankings	GET /event/{event_key}/rankings
getEventSimple	GET /event/{event_key}/simple
getEventTeams	GET /event/{event_key}/teams
getEventTeamsKeys	GET /event/{event_key}/teams/keys
getEventTeamsSimple	GET /event/{event_key}/teams/simple
getEventTeamsStatuses	GET /event/{event_key}/teams/statuses
getEventsByYear	GET /events/{year}
getEventsByYearKeys	GET /events/{year}/keys
getEventsByYearSimple	GET /events/{year}/simple
getTeamEventAwards	GET /team/{team_key}/event/{event_key}/awards
getTeamEventMatches	GET /team/{team_key}/event/{event_key}/matches
getTeamEventMatchesKeys	GET /team/{team_key}/event/{event_key}/matches/keys
getTeamEventMatchesSimple	GET /team/{team_key}/event/{event_key}/matches/simple
getTeamEventStatus	GET /team/{team_key}/event/{event_key}/status
getTeamEvents	GET /team/{team_key}/events
getTeamEventsByYear	GET /team/{team_key}/events/{year}
getTeamEventsByYearKeys	GET /team/{team_key}/events/{year}/keys
getTeamEventsByYearSimple	GET /team/{team_key}/events/{year}/simple
getTeamEventsKeys	GET /team/{team_key}/events/keys
getTeamEventsSimple	GET /team/{team_key}/events/simple
getTeamEventsStatusesByYear	GET /team/{team_key}/events/{year}/statuses

getDistrictEvents

BuiltList getDistrictEvents(districtKey, ifNoneMatch)

Gets a list of events in the given district.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String districtKey = districtKey_example; // String | TBA District Key, eg `2016fim`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getDistrictEvents(districtKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getDistrictEvents: $e\n');
}

Parameters

Name	Type	Description	Notes
districtKey	String	TBA District Key, eg 2016fim
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Event>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getDistrictEventsKeys

BuiltList getDistrictEventsKeys(districtKey, ifNoneMatch)

Gets a list of event keys for events in the given district.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String districtKey = districtKey_example; // String | TBA District Key, eg `2016fim`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getDistrictEventsKeys(districtKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getDistrictEventsKeys: $e\n');
}

Parameters

Name	Type	Description	Notes
districtKey	String	TBA District Key, eg 2016fim
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getDistrictEventsSimple

BuiltList getDistrictEventsSimple(districtKey, ifNoneMatch)

Gets a short-form list of events in the given district.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String districtKey = districtKey_example; // String | TBA District Key, eg `2016fim`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getDistrictEventsSimple(districtKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getDistrictEventsSimple: $e\n');
}

Parameters

Name	Type	Description	Notes
districtKey	String	TBA District Key, eg 2016fim
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<EventSimple>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getEvent

Event getEvent(eventKey, ifNoneMatch)

Gets an Event.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEvent(eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getEvent: $e\n');
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

Event

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getEventAlliances

BuiltList getEventAlliances(eventKey, ifNoneMatch)

Gets a list of Elimination Alliances for the given Event.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventAlliances(eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getEventAlliances: $e\n');
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<EliminationAlliance>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getEventAwards

BuiltList getEventAwards(eventKey, ifNoneMatch)

Gets a list of awards from the given event.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventAwards(eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getEventAwards: $e\n');
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Award>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getEventDistrictPoints

EventDistrictPoints getEventDistrictPoints(eventKey, ifNoneMatch)

Gets a list of team rankings for the Event.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventDistrictPoints(eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getEventDistrictPoints: $e\n');
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

EventDistrictPoints

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getEventInsights

EventInsights getEventInsights(eventKey, ifNoneMatch)

Gets a set of Event-specific insights for the given Event.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventInsights(eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getEventInsights: $e\n');
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

EventInsights

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getEventMatchTimeseries

BuiltList getEventMatchTimeseries(eventKey, ifNoneMatch)

Gets an array of Match Keys for the given event key that have timeseries data. Returns an empty array if no matches have timeseries data. WARNING: This is not official data, and is subject to a significant possibility of error, or missing data. Do not rely on this data for any purpose. In fact, pretend we made it up. WARNING: This endpoint and corresponding data models are under active development and may change at any time, including in breaking ways.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventMatchTimeseries(eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getEventMatchTimeseries: $e\n');
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getEventMatches

BuiltList getEventMatches(eventKey, ifNoneMatch)

Gets a list of matches for the given event.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventMatches(eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getEventMatches: $e\n');
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Match>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getEventMatchesKeys

BuiltList getEventMatchesKeys(eventKey, ifNoneMatch)

Gets a list of match keys for the given event.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventMatchesKeys(eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getEventMatchesKeys: $e\n');
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getEventMatchesSimple

BuiltList getEventMatchesSimple(eventKey, ifNoneMatch)

Gets a short-form list of matches for the given event.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventMatchesSimple(eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getEventMatchesSimple: $e\n');
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<MatchSimple>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getEventOPRs

EventOPRs getEventOPRs(eventKey, ifNoneMatch)

Gets a set of Event OPRs (including OPR, DPR, and CCWM) for the given Event.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventOPRs(eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getEventOPRs: $e\n');
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

EventOPRs

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getEventPredictions

JsonObject getEventPredictions(eventKey, ifNoneMatch)

Gets information on TBA-generated predictions for the given Event. Contains year-specific information. WARNING This endpoint is currently under development and may change at any time.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventPredictions(eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getEventPredictions: $e\n');
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

JsonObject

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getEventRankings

EventRanking getEventRankings(eventKey, ifNoneMatch)

Gets a list of team rankings for the Event.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventRankings(eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getEventRankings: $e\n');
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

EventRanking

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getEventSimple

EventSimple getEventSimple(eventKey, ifNoneMatch)

Gets a short-form Event.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventSimple(eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getEventSimple: $e\n');
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

EventSimple

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getEventTeams

BuiltList getEventTeams(eventKey, ifNoneMatch)

Gets a list of Team objects that competed in the given event.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventTeams(eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getEventTeams: $e\n');
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Team>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getEventTeamsKeys

BuiltList getEventTeamsKeys(eventKey, ifNoneMatch)

Gets a list of Team keys that competed in the given event.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventTeamsKeys(eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getEventTeamsKeys: $e\n');
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getEventTeamsSimple

BuiltList getEventTeamsSimple(eventKey, ifNoneMatch)

Gets a short-form list of Team objects that competed in the given event.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventTeamsSimple(eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getEventTeamsSimple: $e\n');
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<TeamSimple>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getEventTeamsStatuses

BuiltMap<String, TeamEventStatus> getEventTeamsStatuses(eventKey, ifNoneMatch)

Gets a key-value list of the event statuses for teams competing at the given event.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventTeamsStatuses(eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getEventTeamsStatuses: $e\n');
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltMap<String, TeamEventStatus>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getEventsByYear

BuiltList getEventsByYear(year, ifNoneMatch)

Gets a list of events in the given year.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventsByYear(year, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getEventsByYear: $e\n');
}

Parameters

Name	Type	Description	Notes
year	int	Competition Year (or Season). Must be 4 digits.
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Event>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getEventsByYearKeys

BuiltList getEventsByYearKeys(year, ifNoneMatch)

Gets a list of event keys in the given year.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventsByYearKeys(year, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getEventsByYearKeys: $e\n');
}

Parameters

Name	Type	Description	Notes
year	int	Competition Year (or Season). Must be 4 digits.
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getEventsByYearSimple

BuiltList getEventsByYearSimple(year, ifNoneMatch)

Gets a short-form list of events in the given year.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventsByYearSimple(year, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getEventsByYearSimple: $e\n');
}

Parameters

Name	Type	Description	Notes
year	int	Competition Year (or Season). Must be 4 digits.
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<EventSimple>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getTeamEventAwards

BuiltList getTeamEventAwards(teamKey, eventKey, ifNoneMatch)

Gets a list of awards the given team won at the given event.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventAwards(teamKey, eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getTeamEventAwards: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Award>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getTeamEventMatches

BuiltList getTeamEventMatches(teamKey, eventKey, ifNoneMatch)

Gets a list of matches for the given team and event.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventMatches(teamKey, eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getTeamEventMatches: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Match>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getTeamEventMatchesKeys

BuiltList getTeamEventMatchesKeys(teamKey, eventKey, ifNoneMatch)

Gets a list of match keys for matches for the given team and event.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventMatchesKeys(teamKey, eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getTeamEventMatchesKeys: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getTeamEventMatchesSimple

BuiltList getTeamEventMatchesSimple(teamKey, eventKey, ifNoneMatch)

Gets a short-form list of matches for the given team and event.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventMatchesSimple(teamKey, eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getTeamEventMatchesSimple: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Match>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getTeamEventStatus

TeamEventStatus getTeamEventStatus(teamKey, eventKey, ifNoneMatch)

Gets the competition rank and status of the team at the given event.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventStatus(teamKey, eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getTeamEventStatus: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

TeamEventStatus

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getTeamEvents

BuiltList getTeamEvents(teamKey, ifNoneMatch)

Gets a list of all events this team has competed at.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEvents(teamKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getTeamEvents: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Event>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getTeamEventsByYear

BuiltList getTeamEventsByYear(teamKey, year, ifNoneMatch)

Gets a list of events this team has competed at in the given year.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventsByYear(teamKey, year, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getTeamEventsByYear: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
year	int	Competition Year (or Season). Must be 4 digits.
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Event>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getTeamEventsByYearKeys

BuiltList getTeamEventsByYearKeys(teamKey, year, ifNoneMatch)

Gets a list of the event keys for events this team has competed at in the given year.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventsByYearKeys(teamKey, year, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getTeamEventsByYearKeys: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
year	int	Competition Year (or Season). Must be 4 digits.
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getTeamEventsByYearSimple

BuiltList getTeamEventsByYearSimple(teamKey, year, ifNoneMatch)

Gets a short-form list of events this team has competed at in the given year.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventsByYearSimple(teamKey, year, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getTeamEventsByYearSimple: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
year	int	Competition Year (or Season). Must be 4 digits.
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<EventSimple>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getTeamEventsKeys

BuiltList getTeamEventsKeys(teamKey, ifNoneMatch)

Gets a list of the event keys for all events this team has competed at.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventsKeys(teamKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getTeamEventsKeys: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getTeamEventsSimple

BuiltList getTeamEventsSimple(teamKey, ifNoneMatch)

Gets a short-form list of all events this team has competed at.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventsSimple(teamKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getTeamEventsSimple: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<EventSimple>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getTeamEventsStatusesByYear

BuiltMap<String, TeamEventStatus> getTeamEventsStatusesByYear(teamKey, year, ifNoneMatch)

Gets a key-value list of the event statuses for events this team has competed at in the given year.

Example

import 'package:tba_api_v3/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api = TbaApiV3().getEventApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventsStatusesByYear(teamKey, year, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EventApi->getTeamEventsStatusesByYear: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
year	int	Competition Year (or Season). Must be 4 digits.
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltMap<String, TeamEventStatus>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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