TBAAPI\v3client\ListApi

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

Method	HTTP request	Description
getDistrictEvents	GET /district/{district_key}/events
getDistrictEventsKeys	GET /district/{district_key}/events/keys
getDistrictEventsSimple	GET /district/{district_key}/events/simple
getDistrictRankings	GET /district/{district_key}/rankings
getDistrictTeams	GET /district/{district_key}/teams
getDistrictTeamsKeys	GET /district/{district_key}/teams/keys
getDistrictTeamsSimple	GET /district/{district_key}/teams/simple
getEventTeams	GET /event/{event_key}/teams
getEventTeamsKeys	GET /event/{event_key}/teams/keys
getEventTeamsSimple	GET /event/{event_key}/teams/simple
getEventTeamsStatuses	GET /event/{event_key}/teams/statuses
getEventsByYear	GET /events/{year}
getEventsByYearKeys	GET /events/{year}/keys
getEventsByYearSimple	GET /events/{year}/simple
getTeamEventsStatusesByYear	GET /team/{team_key}/events/{year}/statuses
getTeams	GET /teams/{page_num}
getTeamsByYear	GET /teams/{year}/{page_num}
getTeamsByYearKeys	GET /teams/{year}/{page_num}/keys
getTeamsByYearSimple	GET /teams/{year}/{page_num}/simple
getTeamsKeys	GET /teams/{page_num}/keys
getTeamsSimple	GET /teams/{page_num}/simple

getDistrictEvents

\TBAAPI\v3client\TBAAPI\v3client\model\Event[] getDistrictEvents($district_key, $if_modified_since)

Gets a list of 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\ListApi(
    // 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->getDistrictEvents($district_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->getDistrictEvents: ', $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\Event[]

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getDistrictEventsKeys

string[] getDistrictEventsKeys($district_key, $if_modified_since)

Gets a list of event keys for 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\ListApi(
    // 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->getDistrictEventsKeys($district_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->getDistrictEventsKeys: ', $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]

getDistrictEventsSimple

\TBAAPI\v3client\TBAAPI\v3client\model\EventSimple[] getDistrictEventsSimple($district_key, $if_modified_since)

Gets a short-form list of 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\ListApi(
    // 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->getDistrictEventsSimple($district_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->getDistrictEventsSimple: ', $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\EventSimple[]

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getDistrictRankings

\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\ListApi(
    // 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 ListApi->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\ListApi(
    // 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 ListApi->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\ListApi(
    // 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 ListApi->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\ListApi(
    // 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 ListApi->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\ListApi(
    // 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 ListApi->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\ListApi(
    // 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 ListApi->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\ListApi(
    // 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 ListApi->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\ListApi(
    // 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 ListApi->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]

getEventsByYear

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

Gets a list of events 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\ListApi(
    // 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.
$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->getEventsByYear($year, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->getEventsByYear: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
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]

getEventsByYearKeys

string[] getEventsByYearKeys($year, $if_modified_since)

Gets a list of event keys 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\ListApi(
    // 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.
$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->getEventsByYearKeys($year, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->getEventsByYearKeys: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
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]

getEventsByYearSimple

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

Gets a short-form list of events 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\ListApi(
    // 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.
$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->getEventsByYearSimple($year, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ListApi->getEventsByYearSimple: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
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]

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\ListApi(
    // 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 ListApi->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]

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\ListApi(
    // 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 ListApi->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\ListApi(
    // 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 ListApi->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\ListApi(
    // 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 ListApi->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\ListApi(
    // 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 ListApi->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\ListApi(
    // 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 ListApi->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\ListApi(
    // 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 ListApi->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]

Files

ListApi.md

Latest commit

History

ListApi.md

File metadata and controls

TBAAPI\v3client\ListApi

getDistrictEvents

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictEventsKeys

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictEventsSimple

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictRankings

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictTeams

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictTeamsKeys

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictTeamsSimple

Example

Parameters

Return type

Authorization

HTTP request headers

getEventTeams

Example

Parameters

Return type

Authorization

HTTP request headers

getEventTeamsKeys

Example

Parameters

Return type

Authorization

HTTP request headers

getEventTeamsSimple

Example

Parameters

Return type

Authorization

HTTP request headers

getEventTeamsStatuses

Example

Parameters

Return type

Authorization

HTTP request headers

getEventsByYear

Example

Parameters

Return type

Authorization

HTTP request headers

getEventsByYearKeys