Skip to content

Latest commit

 

History

History
1071 lines (730 loc) · 38 KB

ListApi.md

File metadata and controls

1071 lines (730 loc) · 38 KB

tba_api_client.api.ListApi

Load the API package

import 'package:tba_api_client/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

List getDistrictEvents(districtKey, ifModifiedSince)

Gets a list of events in the given district.

Example

import 'package:tba_api_client/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';

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

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

Parameters

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

Return type

List

Authorization

apiKey

HTTP request headers

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

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

getDistrictEventsKeys

List getDistrictEventsKeys(districtKey, ifModifiedSince)

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

Example

import 'package:tba_api_client/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';

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

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

Parameters

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

Return type

List

Authorization

apiKey

HTTP request headers

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

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

getDistrictEventsSimple

List getDistrictEventsSimple(districtKey, ifModifiedSince)

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

Example

import 'package:tba_api_client/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';

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

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

Parameters

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

Return type

List

Authorization

apiKey

HTTP request headers

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

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

getDistrictRankings

List getDistrictRankings(districtKey, ifModifiedSince)

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

Example

import 'package:tba_api_client/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';

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

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

Parameters

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

Return type

List

Authorization

apiKey

HTTP request headers

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

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

getDistrictTeams

List getDistrictTeams(districtKey, ifModifiedSince)

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

Example

import 'package:tba_api_client/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';

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

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

Parameters

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

Return type

List

Authorization

apiKey

HTTP request headers

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

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

getDistrictTeamsKeys

List getDistrictTeamsKeys(districtKey, ifModifiedSince)

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

Example

import 'package:tba_api_client/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';

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

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

Parameters

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

Return type

List

Authorization

apiKey

HTTP request headers

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

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

getDistrictTeamsSimple

List getDistrictTeamsSimple(districtKey, ifModifiedSince)

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

Example

import 'package:tba_api_client/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';

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

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

Parameters

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

Return type

List

Authorization

apiKey

HTTP request headers

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

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

getEventTeams

List getEventTeams(eventKey, ifModifiedSince)

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

Example

import 'package:tba_api_client/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';

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

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

Parameters

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

Return type

List

Authorization

apiKey

HTTP request headers

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

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

getEventTeamsKeys

List getEventTeamsKeys(eventKey, ifModifiedSince)

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

Example

import 'package:tba_api_client/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';

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

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

Parameters

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

Return type

List

Authorization

apiKey

HTTP request headers

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

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

getEventTeamsSimple

List getEventTeamsSimple(eventKey, ifModifiedSince)

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

Example

import 'package:tba_api_client/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';

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

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

Parameters

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

Return type

List

Authorization

apiKey

HTTP request headers

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

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

getEventTeamsStatuses

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

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

Example

import 'package:tba_api_client/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';

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

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

Parameters

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

Return type

Map<String, TeamEventStatus>

Authorization

apiKey

HTTP request headers

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

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

getEventsByYear

List getEventsByYear(year, ifModifiedSince)

Gets a list of events in the given year.

Example

import 'package:tba_api_client/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';

var api_instance = ListApi();
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

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

Parameters

Name Type Description Notes
year int Competition Year (or Season). Must be 4 digits. [default to null]
ifModifiedSince String Value of the `Last-Modified` header in the most recently cached response by the client. [optional] [default to null]

Return type

List

Authorization

apiKey

HTTP request headers

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

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

getEventsByYearKeys

List getEventsByYearKeys(year, ifModifiedSince)

Gets a list of event keys in the given year.

Example

import 'package:tba_api_client/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';

var api_instance = ListApi();
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

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

Parameters

Name Type Description Notes
year int Competition Year (or Season). Must be 4 digits. [default to null]
ifModifiedSince String Value of the `Last-Modified` header in the most recently cached response by the client. [optional] [default to null]

Return type

List

Authorization

apiKey

HTTP request headers

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

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

getEventsByYearSimple

List getEventsByYearSimple(year, ifModifiedSince)

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

Example

import 'package:tba_api_client/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';

var api_instance = ListApi();
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

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

Parameters

Name Type Description Notes
year int Competition Year (or Season). Must be 4 digits. [default to null]
ifModifiedSince String Value of the `Last-Modified` header in the most recently cached response by the client. [optional] [default to null]

Return type

List

Authorization

apiKey

HTTP request headers

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

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

getTeamEventsStatusesByYear

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

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

Example

import 'package:tba_api_client/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';

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

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

Parameters

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

Return type

Map<String, TeamEventStatus>

Authorization

apiKey

HTTP request headers

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

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

getTeams

List getTeams(pageNum, ifModifiedSince)

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

Example

import 'package:tba_api_client/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';

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

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

Parameters

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

Return type

List

Authorization

apiKey

HTTP request headers

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

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

getTeamsByYear

List getTeamsByYear(year, pageNum, ifModifiedSince)

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

Example

import 'package:tba_api_client/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';

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

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

Parameters

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

Return type

List

Authorization

apiKey

HTTP request headers

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

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

getTeamsByYearKeys

List getTeamsByYearKeys(year, pageNum, ifModifiedSince)

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

Example

import 'package:tba_api_client/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';

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

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

Parameters

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

Return type

List

Authorization

apiKey

HTTP request headers

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

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

getTeamsByYearSimple

List getTeamsByYearSimple(year, pageNum, ifModifiedSince)

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

Example

import 'package:tba_api_client/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';

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

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

Parameters

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

Return type

List

Authorization

apiKey

HTTP request headers

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

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

getTeamsKeys

List getTeamsKeys(pageNum, ifModifiedSince)

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

Example

import 'package:tba_api_client/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';

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

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

Parameters

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

Return type

List

Authorization

apiKey

HTTP request headers

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

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

getTeamsSimple

List getTeamsSimple(pageNum, ifModifiedSince)

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

Example

import 'package:tba_api_client/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';

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

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

Parameters

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

Return type

List

Authorization

apiKey

HTTP request headers

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

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