Skip to content

Latest commit

 

History

History
2250 lines (1638 loc) · 78.4 KB

TeamApi.md

File metadata and controls

2250 lines (1638 loc) · 78.4 KB
Raw

TeamApi

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
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
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<DistrictRanking> getDistrictRankings(districtKey, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String districtKey = "districtKey_example"; // String | TBA District Key, eg `2016fim`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<DistrictRanking> result = apiInstance.getDistrictRankings(districtKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getDistrictRankings");
    e.printStackTrace();
}

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<DistrictRanking>

Authorization

apiKey

HTTP request headers

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

getDistrictTeams

List<Team> getDistrictTeams(districtKey, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String districtKey = "districtKey_example"; // String | TBA District Key, eg `2016fim`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<Team> result = apiInstance.getDistrictTeams(districtKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getDistrictTeams");
    e.printStackTrace();
}

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<Team>

Authorization

apiKey

HTTP request headers

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

getDistrictTeamsKeys

List<String> getDistrictTeamsKeys(districtKey, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String districtKey = "districtKey_example"; // String | TBA District Key, eg `2016fim`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<String> result = apiInstance.getDistrictTeamsKeys(districtKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getDistrictTeamsKeys");
    e.printStackTrace();
}

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<String>

Authorization

apiKey

HTTP request headers

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

getDistrictTeamsSimple

List<TeamSimple> getDistrictTeamsSimple(districtKey, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String districtKey = "districtKey_example"; // String | TBA District Key, eg `2016fim`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<TeamSimple> result = apiInstance.getDistrictTeamsSimple(districtKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getDistrictTeamsSimple");
    e.printStackTrace();
}

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<TeamSimple>

Authorization

apiKey

HTTP request headers

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

getEventTeams

List<Team> getEventTeams(eventKey, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String eventKey = "eventKey_example"; // String | TBA Event Key, eg `2016nytr`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<Team> result = apiInstance.getEventTeams(eventKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getEventTeams");
    e.printStackTrace();
}

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<Team>

Authorization

apiKey

HTTP request headers

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

getEventTeamsKeys

List<String> getEventTeamsKeys(eventKey, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String eventKey = "eventKey_example"; // String | TBA Event Key, eg `2016nytr`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<String> result = apiInstance.getEventTeamsKeys(eventKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getEventTeamsKeys");
    e.printStackTrace();
}

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<String>

Authorization

apiKey

HTTP request headers

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

getEventTeamsSimple

List<TeamSimple> getEventTeamsSimple(eventKey, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String eventKey = "eventKey_example"; // String | TBA Event Key, eg `2016nytr`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<TeamSimple> result = apiInstance.getEventTeamsSimple(eventKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getEventTeamsSimple");
    e.printStackTrace();
}

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<TeamSimple>

Authorization

apiKey

HTTP request headers

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

getTeam

Team getTeam(teamKey, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    Team result = apiInstance.getTeam(teamKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeam");
    e.printStackTrace();
}

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

getTeamAwards

List<Award> getTeamAwards(teamKey, ifModifiedSince)

Gets a list of awards the given team has won.

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<Award> result = apiInstance.getTeamAwards(teamKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamAwards");
    e.printStackTrace();
}

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<Award>

Authorization

apiKey

HTTP request headers

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

getTeamAwardsByYear

List<Award> getTeamAwardsByYear(teamKey, year, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
BigDecimal year = new BigDecimal(); // BigDecimal | Competition Year (or Season). Must be 4 digits.
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<Award> result = apiInstance.getTeamAwardsByYear(teamKey, year, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamAwardsByYear");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
teamKey String TBA Team Key, eg `frc254`
year BigDecimal 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<Award>

Authorization

apiKey

HTTP request headers

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

getTeamDistricts

Map<String, String> getTeamDistricts(teamKey, ifModifiedSince)

Gets a list or year and district pairs to denote each year the team was in a district. Will return an empty array if the team was never in a district.

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    Map<String, String> result = apiInstance.getTeamDistricts(teamKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamDistricts");
    e.printStackTrace();
}

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

Map<String, String>

Authorization

apiKey

HTTP request headers

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

getTeamEventAwards

List<Award> getTeamEventAwards(teamKey, eventKey, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
String eventKey = "eventKey_example"; // String | TBA Event Key, eg `2016nytr`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<Award> result = apiInstance.getTeamEventAwards(teamKey, eventKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamEventAwards");
    e.printStackTrace();
}

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<Award>

Authorization

apiKey

HTTP request headers

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

getTeamEventMatches

List<Match> getTeamEventMatches(teamKey, eventKey, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
String eventKey = "eventKey_example"; // String | TBA Event Key, eg `2016nytr`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<Match> result = apiInstance.getTeamEventMatches(teamKey, eventKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamEventMatches");
    e.printStackTrace();
}

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<Match>

Authorization

apiKey

HTTP request headers

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

getTeamEventMatchesKeys

List<String> getTeamEventMatchesKeys(teamKey, eventKey, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
String eventKey = "eventKey_example"; // String | TBA Event Key, eg `2016nytr`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<String> result = apiInstance.getTeamEventMatchesKeys(teamKey, eventKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamEventMatchesKeys");
    e.printStackTrace();
}

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<String>

Authorization

apiKey

HTTP request headers

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

getTeamEventMatchesSimple

List<Match> getTeamEventMatchesSimple(teamKey, eventKey, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
String eventKey = "eventKey_example"; // String | TBA Event Key, eg `2016nytr`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<Match> result = apiInstance.getTeamEventMatchesSimple(teamKey, eventKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamEventMatchesSimple");
    e.printStackTrace();
}

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<Match>

Authorization

apiKey

HTTP request headers

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

getTeamEventStatus

TeamEventStatus getTeamEventStatus(teamKey, eventKey, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
String eventKey = "eventKey_example"; // String | TBA Event Key, eg `2016nytr`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    TeamEventStatus result = apiInstance.getTeamEventStatus(teamKey, eventKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamEventStatus");
    e.printStackTrace();
}

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

getTeamEvents

List<Event> getTeamEvents(teamKey, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<Event> result = apiInstance.getTeamEvents(teamKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamEvents");
    e.printStackTrace();
}

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<Event>

Authorization

apiKey

HTTP request headers

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

getTeamEventsByYear

List<Event> getTeamEventsByYear(teamKey, year, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
BigDecimal year = new BigDecimal(); // BigDecimal | Competition Year (or Season). Must be 4 digits.
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<Event> result = apiInstance.getTeamEventsByYear(teamKey, year, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamEventsByYear");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
teamKey String TBA Team Key, eg `frc254`
year BigDecimal 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<Event>

Authorization

apiKey

HTTP request headers

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

getTeamEventsByYearKeys

List<String> getTeamEventsByYearKeys(teamKey, year, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
BigDecimal year = new BigDecimal(); // BigDecimal | Competition Year (or Season). Must be 4 digits.
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<String> result = apiInstance.getTeamEventsByYearKeys(teamKey, year, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamEventsByYearKeys");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
teamKey String TBA Team Key, eg `frc254`
year BigDecimal 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<String>

Authorization

apiKey

HTTP request headers

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

getTeamEventsByYearSimple

List<EventSimple> getTeamEventsByYearSimple(teamKey, year, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
BigDecimal year = new BigDecimal(); // BigDecimal | Competition Year (or Season). Must be 4 digits.
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<EventSimple> result = apiInstance.getTeamEventsByYearSimple(teamKey, year, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamEventsByYearSimple");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
teamKey String TBA Team Key, eg `frc254`
year BigDecimal 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<EventSimple>

Authorization

apiKey

HTTP request headers

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

getTeamEventsKeys

List<String> getTeamEventsKeys(teamKey, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<String> result = apiInstance.getTeamEventsKeys(teamKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamEventsKeys");
    e.printStackTrace();
}

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<String>

Authorization

apiKey

HTTP request headers

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

getTeamEventsSimple

List<EventSimple> getTeamEventsSimple(teamKey, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<EventSimple> result = apiInstance.getTeamEventsSimple(teamKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamEventsSimple");
    e.printStackTrace();
}

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<EventSimple>

Authorization

apiKey

HTTP request headers

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

getTeamMatchesByYear

List<Match> getTeamMatchesByYear(teamKey, year, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
BigDecimal year = new BigDecimal(); // BigDecimal | Competition Year (or Season). Must be 4 digits.
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<Match> result = apiInstance.getTeamMatchesByYear(teamKey, year, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamMatchesByYear");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
teamKey String TBA Team Key, eg `frc254`
year BigDecimal 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<Match>

Authorization

apiKey

HTTP request headers

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

getTeamMatchesByYearKeys

List<String> getTeamMatchesByYearKeys(teamKey, year, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
BigDecimal year = new BigDecimal(); // BigDecimal | Competition Year (or Season). Must be 4 digits.
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<String> result = apiInstance.getTeamMatchesByYearKeys(teamKey, year, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamMatchesByYearKeys");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
teamKey String TBA Team Key, eg `frc254`
year BigDecimal 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<String>

Authorization

apiKey

HTTP request headers

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

getTeamMatchesByYearSimple

List<MatchSimple> getTeamMatchesByYearSimple(teamKey, year, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
BigDecimal year = new BigDecimal(); // BigDecimal | Competition Year (or Season). Must be 4 digits.
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<MatchSimple> result = apiInstance.getTeamMatchesByYearSimple(teamKey, year, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamMatchesByYearSimple");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
teamKey String TBA Team Key, eg `frc254`
year BigDecimal 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<MatchSimple>

Authorization

apiKey

HTTP request headers

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

getTeamMediaByTag

List<Media> getTeamMediaByTag(teamKey, mediaTag, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
String mediaTag = "mediaTag_example"; // String | Media Tag which describes the Media.
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<Media> result = apiInstance.getTeamMediaByTag(teamKey, mediaTag, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamMediaByTag");
    e.printStackTrace();
}

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<Media>

Authorization

apiKey

HTTP request headers

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

getTeamMediaByTagYear

List<Media> getTeamMediaByTagYear(teamKey, mediaTag, year, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
String mediaTag = "mediaTag_example"; // String | Media Tag which describes the Media.
BigDecimal year = new BigDecimal(); // BigDecimal | Competition Year (or Season). Must be 4 digits.
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<Media> result = apiInstance.getTeamMediaByTagYear(teamKey, mediaTag, year, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamMediaByTagYear");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
teamKey String TBA Team Key, eg `frc254`
mediaTag String Media Tag which describes the Media.
year BigDecimal 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<Media>

Authorization

apiKey

HTTP request headers

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

getTeamMediaByYear

List<Media> getTeamMediaByYear(teamKey, year, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
BigDecimal year = new BigDecimal(); // BigDecimal | Competition Year (or Season). Must be 4 digits.
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<Media> result = apiInstance.getTeamMediaByYear(teamKey, year, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamMediaByYear");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
teamKey String TBA Team Key, eg `frc254`
year BigDecimal 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<Media>

Authorization

apiKey

HTTP request headers

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

getTeamRobots

Map<String, TeamRobot> 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 classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    Map<String, TeamRobot> result = apiInstance.getTeamRobots(teamKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamRobots");
    e.printStackTrace();
}

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

Map<String, TeamRobot>

Authorization

apiKey

HTTP request headers

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

getTeamSimple

TeamSimple getTeamSimple(teamKey, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    TeamSimple result = apiInstance.getTeamSimple(teamKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamSimple");
    e.printStackTrace();
}

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

getTeamSocialMedia

List<Media> getTeamSocialMedia(teamKey, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<Media> result = apiInstance.getTeamSocialMedia(teamKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamSocialMedia");
    e.printStackTrace();
}

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<Media>

Authorization

apiKey

HTTP request headers

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

getTeamYearsParticipated

List<Integer> getTeamYearsParticipated(teamKey, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<Integer> result = apiInstance.getTeamYearsParticipated(teamKey, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamYearsParticipated");
    e.printStackTrace();
}

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<Integer>

Authorization

apiKey

HTTP request headers

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

getTeams

List<Team> getTeams(pageNum, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
BigDecimal pageNum = new BigDecimal(); // BigDecimal | Page number of results to return, zero-indexed
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<Team> result = apiInstance.getTeams(pageNum, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeams");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pageNum BigDecimal 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<Team>

Authorization

apiKey

HTTP request headers

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

getTeamsByYear

List<Team> getTeamsByYear(year, pageNum, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
BigDecimal year = new BigDecimal(); // BigDecimal | Competition Year (or Season). Must be 4 digits.
BigDecimal pageNum = new BigDecimal(); // BigDecimal | Page number of results to return, zero-indexed
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<Team> result = apiInstance.getTeamsByYear(year, pageNum, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamsByYear");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
year BigDecimal Competition Year (or Season). Must be 4 digits.
pageNum BigDecimal 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<Team>

Authorization

apiKey

HTTP request headers

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

getTeamsByYearKeys

List<String> getTeamsByYearKeys(year, pageNum, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
BigDecimal year = new BigDecimal(); // BigDecimal | Competition Year (or Season). Must be 4 digits.
BigDecimal pageNum = new BigDecimal(); // BigDecimal | Page number of results to return, zero-indexed
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<String> result = apiInstance.getTeamsByYearKeys(year, pageNum, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamsByYearKeys");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
year BigDecimal Competition Year (or Season). Must be 4 digits.
pageNum BigDecimal 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<String>

Authorization

apiKey

HTTP request headers

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

getTeamsByYearSimple

List<TeamSimple> 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 classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
BigDecimal year = new BigDecimal(); // BigDecimal | Competition Year (or Season). Must be 4 digits.
BigDecimal pageNum = new BigDecimal(); // BigDecimal | Page number of results to return, zero-indexed
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<TeamSimple> result = apiInstance.getTeamsByYearSimple(year, pageNum, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamsByYearSimple");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
year BigDecimal Competition Year (or Season). Must be 4 digits.
pageNum BigDecimal 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<TeamSimple>

Authorization

apiKey

HTTP request headers

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

getTeamsKeys

List<String> 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 classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
BigDecimal pageNum = new BigDecimal(); // BigDecimal | Page number of results to return, zero-indexed
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<String> result = apiInstance.getTeamsKeys(pageNum, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamsKeys");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pageNum BigDecimal 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<String>

Authorization

apiKey

HTTP request headers

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

getTeamsSimple

List<TeamSimple> getTeamsSimple(pageNum, ifModifiedSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TeamApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

TeamApi apiInstance = new TeamApi();
BigDecimal pageNum = new BigDecimal(); // BigDecimal | Page number of results to return, zero-indexed
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    List<TeamSimple> result = apiInstance.getTeamsSimple(pageNum, ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TeamApi#getTeamsSimple");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pageNum BigDecimal 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<TeamSimple>

Authorization

apiKey

HTTP request headers

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