TeamApi.md

TBAAPI\v3client\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
getEventTeamsStatuses	GET /event/{event_key}/teams/statuses
getTeam	GET /team/{team_key}
getTeamAwards	GET /team/{team_key}/awards
getTeamAwardsByYear	GET /team/{team_key}/awards/{year}
getTeamDistricts	GET /team/{team_key}/districts
getTeamEventAwards	GET /team/{team_key}/event/{event_key}/awards
getTeamEventMatches	GET /team/{team_key}/event/{event_key}/matches
getTeamEventMatchesKeys	GET /team/{team_key}/event/{event_key}/matches/keys
getTeamEventMatchesSimple	GET /team/{team_key}/event/{event_key}/matches/simple
getTeamEventStatus	GET /team/{team_key}/event/{event_key}/status
getTeamEvents	GET /team/{team_key}/events
getTeamEventsByYear	GET /team/{team_key}/events/{year}
getTeamEventsByYearKeys	GET /team/{team_key}/events/{year}/keys
getTeamEventsByYearSimple	GET /team/{team_key}/events/{year}/simple
getTeamEventsKeys	GET /team/{team_key}/events/keys
getTeamEventsSimple	GET /team/{team_key}/events/simple
getTeamEventsStatusesByYear	GET /team/{team_key}/events/{year}/statuses
getTeamMatchesByYear	GET /team/{team_key}/matches/{year}
getTeamMatchesByYearKeys	GET /team/{team_key}/matches/{year}/keys
getTeamMatchesByYearSimple	GET /team/{team_key}/matches/{year}/simple
getTeamMediaByTag	GET /team/{team_key}/media/tag/{media_tag}
getTeamMediaByTagYear	GET /team/{team_key}/media/tag/{media_tag}/{year}
getTeamMediaByYear	GET /team/{team_key}/media/{year}
getTeamRobots	GET /team/{team_key}/robots
getTeamSimple	GET /team/{team_key}/simple
getTeamSocialMedia	GET /team/{team_key}/social_media
getTeamYearsParticipated	GET /team/{team_key}/years_participated
getTeams	GET /teams/{page_num}
getTeamsByYear	GET /teams/{year}/{page_num}
getTeamsByYearKeys	GET /teams/{year}/{page_num}/keys
getTeamsByYearSimple	GET /teams/{year}/{page_num}/simple
getTeamsKeys	GET /teams/{page_num}/keys
getTeamsSimple	GET /teams/{page_num}/simple

getDistrictRankings

\TBAAPI\v3client\TBAAPI\v3client\model\DistrictRanking[] getDistrictRankings($district_key, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$district_key = 'district_key_example'; // string | TBA District Key, eg `2016fim`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getDistrictRankings($district_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getDistrictRankings: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\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

\TBAAPI\v3client\TBAAPI\v3client\model\Team[] getDistrictTeams($district_key, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$district_key = 'district_key_example'; // string | TBA District Key, eg `2016fim`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getDistrictTeams($district_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getDistrictTeams: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\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

string[] getDistrictTeamsKeys($district_key, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$district_key = 'district_key_example'; // string | TBA District Key, eg `2016fim`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getDistrictTeamsKeys($district_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getDistrictTeamsKeys: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

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

\TBAAPI\v3client\TBAAPI\v3client\model\TeamSimple[] getDistrictTeamsSimple($district_key, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$district_key = 'district_key_example'; // string | TBA District Key, eg `2016fim`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getDistrictTeamsSimple($district_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getDistrictTeamsSimple: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\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

\TBAAPI\v3client\TBAAPI\v3client\model\Team[] getEventTeams($event_key, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$event_key = 'event_key_example'; // string | TBA Event Key, eg `2016nytr`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getEventTeams($event_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getEventTeams: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\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

string[] getEventTeamsKeys($event_key, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$event_key = 'event_key_example'; // string | TBA Event Key, eg `2016nytr`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getEventTeamsKeys($event_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getEventTeamsKeys: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

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

\TBAAPI\v3client\TBAAPI\v3client\model\TeamSimple[] getEventTeamsSimple($event_key, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$event_key = 'event_key_example'; // string | TBA Event Key, eg `2016nytr`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getEventTeamsSimple($event_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getEventTeamsSimple: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\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

map[string,\TBAAPI\v3client\TBAAPI\v3client\model\TeamEventStatus] getEventTeamsStatuses($event_key, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$event_key = 'event_key_example'; // string | TBA Event Key, eg `2016nytr`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getEventTeamsStatuses($event_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getEventTeamsStatuses: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

map[string,\TBAAPI\v3client\TBAAPI\v3client\model\TeamEventStatus]

Authorization

apiKey

HTTP request headers

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

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

getTeam

\TBAAPI\v3client\TBAAPI\v3client\model\Team getTeam($team_key, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeam($team_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeam: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\Team

Authorization

apiKey

HTTP request headers

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

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

getTeamAwards

\TBAAPI\v3client\TBAAPI\v3client\model\Award[] getTeamAwards($team_key, $if_modified_since)

Gets a list of awards the given team has won.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamAwards($team_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamAwards: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\Award[]

Authorization

apiKey

HTTP request headers

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

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

getTeamAwardsByYear

\TBAAPI\v3client\TBAAPI\v3client\model\Award[] getTeamAwardsByYear($team_key, $year, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$year = 56; // int | Competition Year (or Season). Must be 4 digits.
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamAwardsByYear($team_key, $year, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamAwardsByYear: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\Award[]

Authorization

apiKey

HTTP request headers

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

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

getTeamDistricts

\TBAAPI\v3client\TBAAPI\v3client\model\DistrictList[] getTeamDistricts($team_key, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamDistricts($team_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamDistricts: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\DistrictList[]

Authorization

apiKey

HTTP request headers

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

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

getTeamEventAwards

\TBAAPI\v3client\TBAAPI\v3client\model\Award[] getTeamEventAwards($team_key, $event_key, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$event_key = 'event_key_example'; // string | TBA Event Key, eg `2016nytr`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamEventAwards($team_key, $event_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamEventAwards: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\Award[]

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

\TBAAPI\v3client\TBAAPI\v3client\model\Match[] getTeamEventMatches($team_key, $event_key, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$event_key = 'event_key_example'; // string | TBA Event Key, eg `2016nytr`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamEventMatches($team_key, $event_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamEventMatches: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\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]

getTeamEventMatchesKeys

string[] getTeamEventMatchesKeys($team_key, $event_key, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$event_key = 'event_key_example'; // string | TBA Event Key, eg `2016nytr`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamEventMatchesKeys($team_key, $event_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamEventMatchesKeys: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

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]

getTeamEventMatchesSimple

\TBAAPI\v3client\TBAAPI\v3client\model\Match[] getTeamEventMatchesSimple($team_key, $event_key, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$event_key = 'event_key_example'; // string | TBA Event Key, eg `2016nytr`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamEventMatchesSimple($team_key, $event_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamEventMatchesSimple: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\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]

getTeamEventStatus

\TBAAPI\v3client\TBAAPI\v3client\model\TeamEventStatus getTeamEventStatus($team_key, $event_key, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$event_key = 'event_key_example'; // string | TBA Event Key, eg `2016nytr`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamEventStatus($team_key, $event_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamEventStatus: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\TeamEventStatus

Authorization

apiKey

HTTP request headers

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

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

getTeamEvents

\TBAAPI\v3client\TBAAPI\v3client\model\Event[] getTeamEvents($team_key, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamEvents($team_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamEvents: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\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]

getTeamEventsByYear

\TBAAPI\v3client\TBAAPI\v3client\model\Event[] getTeamEventsByYear($team_key, $year, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$year = 56; // int | Competition Year (or Season). Must be 4 digits.
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamEventsByYear($team_key, $year, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamEventsByYear: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\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]

getTeamEventsByYearKeys

string[] getTeamEventsByYearKeys($team_key, $year, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$year = 56; // int | Competition Year (or Season). Must be 4 digits.
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamEventsByYearKeys($team_key, $year, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamEventsByYearKeys: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

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]

getTeamEventsByYearSimple

\TBAAPI\v3client\TBAAPI\v3client\model\EventSimple[] getTeamEventsByYearSimple($team_key, $year, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$year = 56; // int | Competition Year (or Season). Must be 4 digits.
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamEventsByYearSimple($team_key, $year, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamEventsByYearSimple: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\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]

getTeamEventsKeys

string[] getTeamEventsKeys($team_key, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamEventsKeys($team_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamEventsKeys: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

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]

getTeamEventsSimple

\TBAAPI\v3client\TBAAPI\v3client\model\EventSimple[] getTeamEventsSimple($team_key, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamEventsSimple($team_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamEventsSimple: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\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

map[string,\TBAAPI\v3client\TBAAPI\v3client\model\TeamEventStatus] getTeamEventsStatusesByYear($team_key, $year, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$year = 56; // int | Competition Year (or Season). Must be 4 digits.
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamEventsStatusesByYear($team_key, $year, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamEventsStatusesByYear: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

map[string,\TBAAPI\v3client\TBAAPI\v3client\model\TeamEventStatus]

Authorization

apiKey

HTTP request headers

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

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

getTeamMatchesByYear

\TBAAPI\v3client\TBAAPI\v3client\model\Match[] getTeamMatchesByYear($team_key, $year, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$year = 56; // int | Competition Year (or Season). Must be 4 digits.
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamMatchesByYear($team_key, $year, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamMatchesByYear: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\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]

getTeamMatchesByYearKeys

string[] getTeamMatchesByYearKeys($team_key, $year, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$year = 56; // int | Competition Year (or Season). Must be 4 digits.
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamMatchesByYearKeys($team_key, $year, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamMatchesByYearKeys: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

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]

getTeamMatchesByYearSimple

\TBAAPI\v3client\TBAAPI\v3client\model\MatchSimple[] getTeamMatchesByYearSimple($team_key, $year, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$year = 56; // int | Competition Year (or Season). Must be 4 digits.
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamMatchesByYearSimple($team_key, $year, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamMatchesByYearSimple: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\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]

getTeamMediaByTag

\TBAAPI\v3client\TBAAPI\v3client\model\Media[] getTeamMediaByTag($team_key, $media_tag, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$media_tag = 'media_tag_example'; // string | Media Tag which describes the Media.
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamMediaByTag($team_key, $media_tag, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamMediaByTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\Media[]

Authorization

apiKey

HTTP request headers

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

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

getTeamMediaByTagYear

\TBAAPI\v3client\TBAAPI\v3client\model\Media[] getTeamMediaByTagYear($team_key, $media_tag, $year, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$media_tag = 'media_tag_example'; // string | Media Tag which describes the Media.
$year = 56; // int | Competition Year (or Season). Must be 4 digits.
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamMediaByTagYear($team_key, $media_tag, $year, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamMediaByTagYear: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\Media[]

Authorization

apiKey

HTTP request headers

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

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

getTeamMediaByYear

\TBAAPI\v3client\TBAAPI\v3client\model\Media[] getTeamMediaByYear($team_key, $year, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$year = 56; // int | Competition Year (or Season). Must be 4 digits.
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamMediaByYear($team_key, $year, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamMediaByYear: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\Media[]

Authorization

apiKey

HTTP request headers

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

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

getTeamRobots

\TBAAPI\v3client\TBAAPI\v3client\model\TeamRobot[] getTeamRobots($team_key, $if_modified_since)

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamRobots($team_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamRobots: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\TeamRobot[]

Authorization

apiKey

HTTP request headers

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

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

getTeamSimple

\TBAAPI\v3client\TBAAPI\v3client\model\TeamSimple getTeamSimple($team_key, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamSimple($team_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamSimple: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\TeamSimple

Authorization

apiKey

HTTP request headers

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

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

getTeamSocialMedia

\TBAAPI\v3client\TBAAPI\v3client\model\Media[] getTeamSocialMedia($team_key, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamSocialMedia($team_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamSocialMedia: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\Media[]

Authorization

apiKey

HTTP request headers

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

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

getTeamYearsParticipated

int[] getTeamYearsParticipated($team_key, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$team_key = 'team_key_example'; // string | TBA Team Key, eg `frc254`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamYearsParticipated($team_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamYearsParticipated: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

int[]

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

\TBAAPI\v3client\TBAAPI\v3client\model\Team[] getTeams($page_num, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$page_num = 56; // int | Page number of results to return, zero-indexed
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeams($page_num, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeams: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\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

\TBAAPI\v3client\TBAAPI\v3client\model\Team[] getTeamsByYear($year, $page_num, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$year = 56; // int | Competition Year (or Season). Must be 4 digits.
$page_num = 56; // int | Page number of results to return, zero-indexed
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamsByYear($year, $page_num, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamsByYear: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\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

string[] getTeamsByYearKeys($year, $page_num, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$year = 56; // int | Competition Year (or Season). Must be 4 digits.
$page_num = 56; // int | Page number of results to return, zero-indexed
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamsByYearKeys($year, $page_num, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamsByYearKeys: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

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

\TBAAPI\v3client\TBAAPI\v3client\model\TeamSimple[] getTeamsByYearSimple($year, $page_num, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$year = 56; // int | Competition Year (or Season). Must be 4 digits.
$page_num = 56; // int | Page number of results to return, zero-indexed
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamsByYearSimple($year, $page_num, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamsByYearSimple: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\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

string[] getTeamsKeys($page_num, $if_modified_since)

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

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$page_num = 56; // int | Page number of results to return, zero-indexed
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamsKeys($page_num, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamsKeys: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

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

\TBAAPI\v3client\TBAAPI\v3client\model\TeamSimple[] getTeamsSimple($page_num, $if_modified_since)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');


$apiInstance = new TBAAPI\v3client\Api\TeamApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$page_num = 56; // int | Page number of results to return, zero-indexed
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    $result = $apiInstance->getTeamsSimple($page_num, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->getTeamsSimple: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\TBAAPI\v3client\TBAAPI\v3client\model\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]