swagger.api.TeamApi

Load the API package

import 'package:swagger/api.dart';

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

Method	HTTP request	Description
getDistrictRankings	GET /district/{district_key}/rankings
getDistrictTeams	GET /district/{district_key}/teams
getDistrictTeamsKeys	GET /district/{district_key}/teams/keys
getDistrictTeamsSimple	GET /district/{district_key}/teams/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
getTeam	GET /team/{team_key}
getTeamAwards	GET /team/{team_key}/awards
getTeamAwardsByYear	GET /team/{team_key}/awards/{year}
getTeamDistricts	GET /team/{team_key}/districts
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
getTeamMatchesByYear	GET /team/{team_key}/matches/{year}
getTeamMatchesByYearKeys	GET /team/{team_key}/matches/{year}/keys
getTeamMatchesByYearSimple	GET /team/{team_key}/matches/{year}/simple
getTeamMediaByTag	GET /team/{team_key}/media/tag/{media_tag}
getTeamMediaByTagYear	GET /team/{team_key}/media/tag/{media_tag}/{year}
getTeamMediaByYear	GET /team/{team_key}/media/{year}
getTeamRobots	GET /team/{team_key}/robots
getTeamSimple	GET /team/{team_key}/simple
getTeamSocialMedia	GET /team/{team_key}/social_media
getTeamYearsParticipated	GET /team/{team_key}/years_participated
getTeams	GET /teams/{page_num}
getTeamsByYear	GET /teams/{year}/{page_num}
getTeamsByYearKeys	GET /teams/{year}/{page_num}/keys
getTeamsByYearSimple	GET /teams/{year}/{page_num}/simple
getTeamsKeys	GET /teams/{page_num}/keys
getTeamsSimple	GET /teams/{page_num}/simple

getDistrictRankings

List getDistrictRankings(districtKey, ifModifiedSince)

Gets a list of team district rankings for the given district.

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var districtKey = districtKey_example; // String | TBA District Key, eg `2016fim`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getDistrictRankings(districtKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getDistrictRankings: $e\n");
}

Parameters

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

Return type

List

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]

getDistrictTeams

List getDistrictTeams(districtKey, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var districtKey = districtKey_example; // String | TBA District Key, eg `2016fim`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getDistrictTeams(districtKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getDistrictTeams: $e\n");
}

Parameters

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

Return type

List

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]

getDistrictTeamsKeys

List getDistrictTeamsKeys(districtKey, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var districtKey = districtKey_example; // String | TBA District Key, eg `2016fim`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getDistrictTeamsKeys(districtKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getDistrictTeamsKeys: $e\n");
}

Parameters

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

Return type

List

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]

getDistrictTeamsSimple

List getDistrictTeamsSimple(districtKey, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var districtKey = districtKey_example; // String | TBA District Key, eg `2016fim`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getDistrictTeamsSimple(districtKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getDistrictTeamsSimple: $e\n");
}

Parameters

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

Return type

List

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

List getEventTeams(eventKey, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getEventTeams(eventKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getEventTeams: $e\n");
}

Parameters

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

Return type

List

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

List getEventTeamsKeys(eventKey, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getEventTeamsKeys(eventKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getEventTeamsKeys: $e\n");
}

Parameters

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

Return type

List

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

List getEventTeamsSimple(eventKey, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getEventTeamsSimple(eventKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getEventTeamsSimple: $e\n");
}

Parameters

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

Return type

List

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

Map<String, TeamEventStatus> getEventTeamsStatuses(eventKey, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getEventTeamsStatuses(eventKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getEventTeamsStatuses: $e\n");
}

Parameters

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

Return type

Map<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]

getTeam

Team getTeam(teamKey, ifModifiedSince)

Gets a Team object for the team referenced by the given key.

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeam(teamKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeam: $e\n");
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

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]

getTeamAwards

List getTeamAwards(teamKey, ifModifiedSince)

Gets a list of awards the given team has won.

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamAwards(teamKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamAwards: $e\n");
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

List

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]

getTeamAwardsByYear

List getTeamAwardsByYear(teamKey, year, ifModifiedSince)

Gets a list of awards the given team has won in a given year.

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamAwardsByYear(teamKey, year, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamAwardsByYear: $e\n");
}

Parameters

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

Return type

List

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]

getTeamDistricts

List getTeamDistricts(teamKey, ifModifiedSince)

Gets an array of districts representing each year the team was in a district. Will return an empty array if the team was never in a district.

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamDistricts(teamKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamDistricts: $e\n");
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

List

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

List getTeamEventAwards(teamKey, eventKey, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamEventAwards(teamKey, eventKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamEventAwards: $e\n");
}

Parameters

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

Return type

List

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

List getTeamEventMatches(teamKey, eventKey, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamEventMatches(teamKey, eventKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamEventMatches: $e\n");
}

Parameters

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

Return type

List

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

List getTeamEventMatchesKeys(teamKey, eventKey, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamEventMatchesKeys(teamKey, eventKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamEventMatchesKeys: $e\n");
}

Parameters

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

Return type

List

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

List getTeamEventMatchesSimple(teamKey, eventKey, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamEventMatchesSimple(teamKey, eventKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamEventMatchesSimple: $e\n");
}

Parameters

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

Return type

List

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, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamEventStatus(teamKey, eventKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamEventStatus: $e\n");
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
eventKey	String	TBA Event Key, eg `2016nytr`
ifModifiedSince	String	Value of the `Last-Modified` 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

List getTeamEvents(teamKey, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamEvents(teamKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamEvents: $e\n");
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

List

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

List getTeamEventsByYear(teamKey, year, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamEventsByYear(teamKey, year, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->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.
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

List

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

List getTeamEventsByYearKeys(teamKey, year, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamEventsByYearKeys(teamKey, year, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->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.
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

List

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

List getTeamEventsByYearSimple(teamKey, year, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamEventsByYearSimple(teamKey, year, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->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.
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

List

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

List getTeamEventsKeys(teamKey, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamEventsKeys(teamKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamEventsKeys: $e\n");
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

List

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

List getTeamEventsSimple(teamKey, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamEventsSimple(teamKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamEventsSimple: $e\n");
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

List

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

Map<String, TeamEventStatus> getTeamEventsStatusesByYear(teamKey, year, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamEventsStatusesByYear(teamKey, year, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->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.
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

Map<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]

getTeamMatchesByYear

List getTeamMatchesByYear(teamKey, year, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamMatchesByYear(teamKey, year, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamMatchesByYear: $e\n");
}

Parameters

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

Return type

List

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]

getTeamMatchesByYearKeys

List getTeamMatchesByYearKeys(teamKey, year, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamMatchesByYearKeys(teamKey, year, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamMatchesByYearKeys: $e\n");
}

Parameters

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

Return type

List

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]

getTeamMatchesByYearSimple

List getTeamMatchesByYearSimple(teamKey, year, ifModifiedSince)

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

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamMatchesByYearSimple(teamKey, year, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamMatchesByYearSimple: $e\n");
}

Parameters

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

Return type

List

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]

getTeamMediaByTag

List getTeamMediaByTag(teamKey, mediaTag, ifModifiedSince)

Gets a list of Media (videos / pictures) for the given team and tag.

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var mediaTag = mediaTag_example; // String | Media Tag which describes the Media.
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamMediaByTag(teamKey, mediaTag, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamMediaByTag: $e\n");
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
mediaTag	String	Media Tag which describes the Media.
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

List

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]

getTeamMediaByTagYear

List getTeamMediaByTagYear(teamKey, mediaTag, year, ifModifiedSince)

Gets a list of Media (videos / pictures) for the given team, tag and year.

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var mediaTag = mediaTag_example; // String | Media Tag which describes the Media.
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamMediaByTagYear(teamKey, mediaTag, year, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamMediaByTagYear: $e\n");
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
mediaTag	String	Media Tag which describes the Media.
year	int	Competition Year (or Season). Must be 4 digits.
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

List

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]

getTeamMediaByYear

List getTeamMediaByYear(teamKey, year, ifModifiedSince)

Gets a list of Media (videos / pictures) for the given team and year.

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamMediaByYear(teamKey, year, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamMediaByYear: $e\n");
}

Parameters

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

Return type

List

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]

getTeamRobots

List getTeamRobots(teamKey, ifModifiedSince)

Gets a list of year and robot name pairs for each year that a robot name was provided. Will return an empty array if the team has never named a robot.

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamRobots(teamKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamRobots: $e\n");
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

List

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]

getTeamSimple

TeamSimple getTeamSimple(teamKey, ifModifiedSince)

Gets a Team_Simple object for the team referenced by the given key.

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamSimple(teamKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamSimple: $e\n");
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

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]

getTeamSocialMedia

List getTeamSocialMedia(teamKey, ifModifiedSince)

Gets a list of Media (social media) for the given team.

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamSocialMedia(teamKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamSocialMedia: $e\n");
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

List

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]

getTeamYearsParticipated

List getTeamYearsParticipated(teamKey, ifModifiedSince)

Gets a list of years in which the team participated in at least one competition.

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamYearsParticipated(teamKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamYearsParticipated: $e\n");
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

List

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]

getTeams

List getTeams(pageNum, ifModifiedSince)

Gets a list of Team objects, paginated in groups of 500.

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var pageNum = 56; // int | Page number of results to return, zero-indexed
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeams(pageNum, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeams: $e\n");
}

Parameters

Name	Type	Description	Notes
pageNum	int	Page number of results to return, zero-indexed
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

List

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]

getTeamsByYear

List getTeamsByYear(year, pageNum, ifModifiedSince)

Gets a list of Team objects that competed in the given year, paginated in groups of 500.

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var pageNum = 56; // int | Page number of results to return, zero-indexed
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamsByYear(year, pageNum, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamsByYear: $e\n");
}

Parameters

Name	Type	Description	Notes
year	int	Competition Year (or Season). Must be 4 digits.
pageNum	int	Page number of results to return, zero-indexed
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

List

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]

getTeamsByYearKeys

List getTeamsByYearKeys(year, pageNum, ifModifiedSince)

Gets a list Team Keys that competed in the given year, paginated in groups of 500.

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var pageNum = 56; // int | Page number of results to return, zero-indexed
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamsByYearKeys(year, pageNum, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamsByYearKeys: $e\n");
}

Parameters

Name	Type	Description	Notes
year	int	Competition Year (or Season). Must be 4 digits.
pageNum	int	Page number of results to return, zero-indexed
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

List

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]

getTeamsByYearSimple

List getTeamsByYearSimple(year, pageNum, ifModifiedSince)

Gets a list of short form Team_Simple objects that competed in the given year, paginated in groups of 500.

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var pageNum = 56; // int | Page number of results to return, zero-indexed
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamsByYearSimple(year, pageNum, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamsByYearSimple: $e\n");
}

Parameters

Name	Type	Description	Notes
year	int	Competition Year (or Season). Must be 4 digits.
pageNum	int	Page number of results to return, zero-indexed
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

List

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]

getTeamsKeys

List getTeamsKeys(pageNum, ifModifiedSince)

Gets a list of Team keys, paginated in groups of 500. (Note, each page will not have 500 teams, but will include the teams within that range of 500.)

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var pageNum = 56; // int | Page number of results to return, zero-indexed
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamsKeys(pageNum, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamsKeys: $e\n");
}

Parameters

Name	Type	Description	Notes
pageNum	int	Page number of results to return, zero-indexed
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

List

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]

getTeamsSimple

List getTeamsSimple(pageNum, ifModifiedSince)

Gets a list of short form Team_Simple objects, paginated in groups of 500.

Example

import 'package:swagger/api.dart';
// TODO Configure API key authorization: apiKey
//swagger.api.Configuration.apiKey{'X-TBA-Auth-Key'} = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//swagger.api.Configuration.apiKeyPrefix{'X-TBA-Auth-Key'} = "Bearer";

var api_instance = new TeamApi();
var pageNum = 56; // int | Page number of results to return, zero-indexed
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamsSimple(pageNum, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling TeamApi->getTeamsSimple: $e\n");
}

Parameters

Name	Type	Description	Notes
pageNum	int	Page number of results to return, zero-indexed
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

List

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]

Files

TeamApi.md

Latest commit

History

TeamApi.md

File metadata and controls

swagger.api.TeamApi

Load the API package

getDistrictRankings

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictTeams

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictTeamsKeys

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictTeamsSimple

Example

Parameters

Return type

Authorization

HTTP request headers

getEventTeams

Example

Parameters

Return type

Authorization

HTTP request headers

getEventTeamsKeys

Example

Parameters

Return type

Authorization

HTTP request headers

getEventTeamsSimple

Example

Parameters

Return type

Authorization

HTTP request headers

getEventTeamsStatuses

Example

Parameters

Return type

Authorization

HTTP request headers

getTeam

Example

Parameters

Return type

Authorization

HTTP request headers

getTeamAwards

Example

Parameters

Return type

Authorization

HTTP request headers

getTeamAwardsByYear

Example

Parameters

Return type

Authorization

HTTP request headers

getTeamDistricts

Example

Parameters

Return type

Authorization

HTTP request headers