Skip to content

ListApi.md

Latest commit

 

History

History
1071 lines (730 loc) · 37.1 KB

ListApi.md

File metadata and controls

1071 lines (730 loc) · 37.1 KB

tba_api_v3.api.ListApi

Load the API package

import 'package:tba_api_v3/api.dart';

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

Method HTTP request Description
getDistrictEvents GET /district/{district_key}/events
getDistrictEventsKeys GET /district/{district_key}/events/keys
getDistrictEventsSimple GET /district/{district_key}/events/simple
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
getEventsByYear GET /events/{year}
getEventsByYearKeys GET /events/{year}/keys
getEventsByYearSimple GET /events/{year}/simple
getTeamEventsStatusesByYear GET /team/{team_key}/events/{year}/statuses
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

getDistrictEvents

BuiltList getDistrictEvents(districtKey, ifNoneMatch)

Gets a list of events in the given district.

Example

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

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

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

Parameters

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

Return type

BuiltList<Event>

Authorization

apiKey

HTTP request headers

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

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

getDistrictEventsKeys

BuiltList getDistrictEventsKeys(districtKey, ifNoneMatch)

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

Example

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

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

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

Parameters

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

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

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

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

getDistrictEventsSimple

BuiltList getDistrictEventsSimple(districtKey, ifNoneMatch)

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

Example

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

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

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

Parameters

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

Return type

BuiltList<EventSimple>

Authorization

apiKey

HTTP request headers

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

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

getDistrictRankings

BuiltList getDistrictRankings(districtKey, ifNoneMatch)

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

Example

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

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

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

Parameters

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

Return type

BuiltList<DistrictRanking>

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

BuiltList getDistrictTeams(districtKey, ifNoneMatch)

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

Example

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

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

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

Parameters

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

Return type

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

getDistrictTeamsKeys

BuiltList getDistrictTeamsKeys(districtKey, ifNoneMatch)

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

Example

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

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

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

Parameters

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

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

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

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

getDistrictTeamsSimple

BuiltList getDistrictTeamsSimple(districtKey, ifNoneMatch)

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

Example

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

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

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

Parameters

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

Return type

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

getEventTeams

BuiltList getEventTeams(eventKey, ifNoneMatch)

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

Example

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

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

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

Parameters

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

Return type

BuiltList<Team>

Authorization

apiKey

HTTP request headers

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

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

getEventTeamsKeys

BuiltList getEventTeamsKeys(eventKey, ifNoneMatch)

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

Example

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

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

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

Parameters

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

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

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

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

getEventTeamsSimple

BuiltList getEventTeamsSimple(eventKey, ifNoneMatch)

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

Example

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

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

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

Parameters

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

Return type

BuiltList<TeamSimple>

Authorization

apiKey

HTTP request headers

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

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

getEventTeamsStatuses

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

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

Example

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

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

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

Parameters

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

Return type

BuiltMap<String, TeamEventStatus>

Authorization

apiKey

HTTP request headers

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

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

getEventsByYear

BuiltList getEventsByYear(year, ifNoneMatch)

Gets a list of events in the given year.

Example

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

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

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

Parameters

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

Return type

BuiltList<Event>

Authorization

apiKey

HTTP request headers

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

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

getEventsByYearKeys

BuiltList getEventsByYearKeys(year, ifNoneMatch)

Gets a list of event keys in the given year.

Example

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

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

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

Parameters

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

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

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

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

getEventsByYearSimple

BuiltList getEventsByYearSimple(year, ifNoneMatch)

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

Example

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

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

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

Parameters

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

Return type

BuiltList<EventSimple>

Authorization

apiKey

HTTP request headers

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

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

getTeamEventsStatusesByYear

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

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

Example

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

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

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

Parameters

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

Return type

BuiltMap<String, TeamEventStatus>

Authorization

apiKey

HTTP request headers

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

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

getTeams

BuiltList getTeams(pageNum, ifNoneMatch)

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

Example

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

final api = TbaApiV3().getListApi();
final int pageNum = 56; // int | Page number of results to return, zero-indexed
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

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

Parameters

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

Return type

BuiltList<Team>

Authorization

apiKey

HTTP request headers

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

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

getTeamsByYear

BuiltList getTeamsByYear(year, pageNum, ifNoneMatch)

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

Example

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

final api = TbaApiV3().getListApi();
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final int pageNum = 56; // int | Page number of results to return, zero-indexed
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamsByYear(year, pageNum, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling ListApi->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
ifNoneMatch String Value of the ETag header in the most recently cached response by the client. [optional]

Return type

BuiltList<Team>

Authorization

apiKey

HTTP request headers

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

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

getTeamsByYearKeys

BuiltList getTeamsByYearKeys(year, pageNum, ifNoneMatch)

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

Example

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

final api = TbaApiV3().getListApi();
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final int pageNum = 56; // int | Page number of results to return, zero-indexed
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamsByYearKeys(year, pageNum, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling ListApi->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
ifNoneMatch String Value of the ETag header in the most recently cached response by the client. [optional]

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

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

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

getTeamsByYearSimple

BuiltList getTeamsByYearSimple(year, pageNum, ifNoneMatch)

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

Example

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

final api = TbaApiV3().getListApi();
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final int pageNum = 56; // int | Page number of results to return, zero-indexed
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamsByYearSimple(year, pageNum, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling ListApi->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
ifNoneMatch String Value of the ETag header in the most recently cached response by the client. [optional]

Return type

BuiltList<TeamSimple>

Authorization

apiKey

HTTP request headers

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

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

getTeamsKeys

BuiltList getTeamsKeys(pageNum, ifNoneMatch)

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

final api = TbaApiV3().getListApi();
final int pageNum = 56; // int | Page number of results to return, zero-indexed
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

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

Parameters

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

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

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

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

getTeamsSimple

BuiltList getTeamsSimple(pageNum, ifNoneMatch)

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

Example

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

final api = TbaApiV3().getListApi();
final int pageNum = 56; // int | Page number of results to return, zero-indexed
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

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

Parameters

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

Return type

BuiltList<TeamSimple>

Authorization

apiKey

HTTP request headers

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

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