Skip to content

Latest commit

 

History

History
725 lines (496 loc) · 26.5 KB

MatchApi.md

File metadata and controls

725 lines (496 loc) · 26.5 KB

tba_api_client.api.MatchApi

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
getEventMatchTimeseries GET /event/{event_key}/matches/timeseries
getEventMatches GET /event/{event_key}/matches
getEventMatchesKeys GET /event/{event_key}/matches/keys
getEventMatchesSimple GET /event/{event_key}/matches/simple
getMatch GET /match/{match_key}
getMatchSimple GET /match/{match_key}/simple
getMatchTimeseries GET /match/{match_key}/timeseries
getMatchZebra GET /match/{match_key}/zebra_motionworks
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
getTeamMatchesByYear GET /team/{team_key}/matches/{year}
getTeamMatchesByYearKeys GET /team/{team_key}/matches/{year}/keys
getTeamMatchesByYearSimple GET /team/{team_key}/matches/{year}/simple

getEventMatchTimeseries

List getEventMatchTimeseries(eventKey, ifModifiedSince)

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

Example

import 'package:tba_api_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 = MatchApi();
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.getEventMatchTimeseries(eventKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling MatchApi->getEventMatchTimeseries: $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]

getEventMatches

List getEventMatches(eventKey, ifModifiedSince)

Gets a list of matches for 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 = MatchApi();
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.getEventMatches(eventKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling MatchApi->getEventMatches: $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]

getEventMatchesKeys

List getEventMatchesKeys(eventKey, ifModifiedSince)

Gets a list of match keys for 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 = MatchApi();
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.getEventMatchesKeys(eventKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling MatchApi->getEventMatchesKeys: $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]

getEventMatchesSimple

List getEventMatchesSimple(eventKey, ifModifiedSince)

Gets a short-form list of matches for 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 = MatchApi();
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.getEventMatchesSimple(eventKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling MatchApi->getEventMatchesSimple: $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]

getMatch

Match getMatch(matchKey, ifModifiedSince)

Gets a Match object for the given match key.

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 = MatchApi();
var matchKey = matchKey_example; // String | TBA Match Key, eg `2016nytr_qm1`
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.getMatch(matchKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling MatchApi->getMatch: $e\n");
}

Parameters

Name Type Description Notes
matchKey String TBA Match Key, eg `2016nytr_qm1` [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

Match

Authorization

apiKey

HTTP request headers

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

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

getMatchSimple

MatchSimple getMatchSimple(matchKey, ifModifiedSince)

Gets a short-form Match object for the given match key.

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 = MatchApi();
var matchKey = matchKey_example; // String | TBA Match Key, eg `2016nytr_qm1`
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.getMatchSimple(matchKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling MatchApi->getMatchSimple: $e\n");
}

Parameters

Name Type Description Notes
matchKey String TBA Match Key, eg `2016nytr_qm1` [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

MatchSimple

Authorization

apiKey

HTTP request headers

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

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

getMatchTimeseries

List getMatchTimeseries(matchKey, ifModifiedSince)

Gets an array of game-specific Match Timeseries objects for the given match key or an empty array if not available. WARNING: This is not official data, and is subject to a significant possibility of error, or missing data. Do not rely on this data for any purpose. In fact, pretend we made it up. WARNING: This endpoint and corresponding data models are under active development and may change at any time, including in breaking ways.

Example

import 'package:tba_api_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 = MatchApi();
var matchKey = matchKey_example; // String | TBA Match Key, eg `2016nytr_qm1`
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.getMatchTimeseries(matchKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling MatchApi->getMatchTimeseries: $e\n");
}

Parameters

Name Type Description Notes
matchKey String TBA Match Key, eg `2016nytr_qm1` [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]

getMatchZebra

Zebra getMatchZebra(matchKey, ifModifiedSince)

Gets Zebra MotionWorks data for a Match for the given match key.

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 = MatchApi();
var matchKey = matchKey_example; // String | TBA Match Key, eg `2016nytr_qm1`
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.getMatchZebra(matchKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling MatchApi->getMatchZebra: $e\n");
}

Parameters

Name Type Description Notes
matchKey String TBA Match Key, eg `2016nytr_qm1` [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

Zebra

Authorization

apiKey

HTTP request headers

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

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

getTeamEventMatches

List getTeamEventMatches(teamKey, eventKey, ifModifiedSince)

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

Example

import 'package: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 = MatchApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

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

Parameters

Name Type Description Notes
teamKey String TBA Team Key, eg `frc254` [default to null]
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]

getTeamEventMatchesKeys

List getTeamEventMatchesKeys(teamKey, eventKey, ifModifiedSince)

Gets a list of match keys for matches for the given team and 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 = MatchApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

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

Parameters

Name Type Description Notes
teamKey String TBA Team Key, eg `frc254` [default to null]
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]

getTeamEventMatchesSimple

List getTeamEventMatchesSimple(teamKey, eventKey, ifModifiedSince)

Gets a short-form list of matches for the given team and 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 = MatchApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

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

Parameters

Name Type Description Notes
teamKey String TBA Team Key, eg `frc254` [default to null]
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]

getTeamMatchesByYear

List getTeamMatchesByYear(teamKey, year, ifModifiedSince)

Gets a list of matches for the given team and 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 = MatchApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamMatchesByYear(teamKey, year, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling MatchApi->getTeamMatchesByYear: $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

List

Authorization

apiKey

HTTP request headers

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

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

getTeamMatchesByYearKeys

List getTeamMatchesByYearKeys(teamKey, year, ifModifiedSince)

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

Example

import 'package: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 = MatchApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamMatchesByYearKeys(teamKey, year, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling MatchApi->getTeamMatchesByYearKeys: $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

List

Authorization

apiKey

HTTP request headers

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

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

getTeamMatchesByYearSimple

List getTeamMatchesByYearSimple(teamKey, year, ifModifiedSince)

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

Example

import 'package: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 = MatchApi();
var teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try { 
    var result = api_instance.getTeamMatchesByYearSimple(teamKey, year, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling MatchApi->getTeamMatchesByYearSimple: $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

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]