TBAAPI\v3client\EventApi

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
getEvent	GET /event/{event_key}
getEventAlliances	GET /event/{event_key}/alliances
getEventAwards	GET /event/{event_key}/awards
getEventDistrictPoints	GET /event/{event_key}/district_points
getEventInsights	GET /event/{event_key}/insights
getEventMatchTimeseries	GET /event/{event_key}/matches/timeseries
getEventMatches	GET /event/{event_key}/matches
getEventMatchesKeys	GET /event/{event_key}/matches/keys
getEventMatchesSimple	GET /event/{event_key}/matches/simple
getEventOPRs	GET /event/{event_key}/oprs
getEventPredictions	GET /event/{event_key}/predictions
getEventRankings	GET /event/{event_key}/rankings
getEventSimple	GET /event/{event_key}/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
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

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

getEvent

\TBAAPI\v3client\TBAAPI\v3client\model\Event getEvent($event_key, $if_modified_since)

Gets an 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\EventApi(
    // 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->getEvent($event_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventApi->getEvent: ', $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\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]

getEventAlliances

\TBAAPI\v3client\TBAAPI\v3client\model\EliminationAlliance[] getEventAlliances($event_key, $if_modified_since)

Gets a list of Elimination Alliances for 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\EventApi(
    // 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->getEventAlliances($event_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventApi->getEventAlliances: ', $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\EliminationAlliance[]

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]

getEventAwards

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

Gets a list of awards from 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\EventApi(
    // 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->getEventAwards($event_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventApi->getEventAwards: ', $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\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]

getEventDistrictPoints

\TBAAPI\v3client\TBAAPI\v3client\model\EventDistrictPoints getEventDistrictPoints($event_key, $if_modified_since)

Gets a list of team rankings for the 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\EventApi(
    // 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->getEventDistrictPoints($event_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventApi->getEventDistrictPoints: ', $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\EventDistrictPoints

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]

getEventInsights

\TBAAPI\v3client\TBAAPI\v3client\model\EventInsights getEventInsights($event_key, $if_modified_since)

Gets a set of Event-specific insights for 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\EventApi(
    // 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->getEventInsights($event_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventApi->getEventInsights: ', $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\EventInsights

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]

getEventMatchTimeseries

string[] getEventMatchTimeseries($event_key, $if_modified_since)

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

Example

<?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\EventApi(
    // 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->getEventMatchTimeseries($event_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventApi->getEventMatchTimeseries: ', $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]

getEventMatches

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

Gets a list of matches for 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\EventApi(
    // 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->getEventMatches($event_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventApi->getEventMatches: ', $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\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]

getEventMatchesKeys

string[] getEventMatchesKeys($event_key, $if_modified_since)

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

getEventMatchesSimple

\TBAAPI\v3client\TBAAPI\v3client\model\MatchSimple[] getEventMatchesSimple($event_key, $if_modified_since)

Gets a short-form list of matches for 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\EventApi(
    // 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->getEventMatchesSimple($event_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventApi->getEventMatchesSimple: ', $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\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]

getEventOPRs

\TBAAPI\v3client\TBAAPI\v3client\model\EventOPRs getEventOPRs($event_key, $if_modified_since)

Gets a set of Event OPRs (including OPR, DPR, and CCWM) for 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\EventApi(
    // 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->getEventOPRs($event_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventApi->getEventOPRs: ', $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\EventOPRs

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]

getEventPredictions

object getEventPredictions($event_key, $if_modified_since)

Gets information on TBA-generated predictions for the given Event. Contains year-specific information. WARNING This endpoint is currently under development and may change at any time.

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\EventApi(
    // 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->getEventPredictions($event_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventApi->getEventPredictions: ', $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

object

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]

getEventRankings

\TBAAPI\v3client\TBAAPI\v3client\model\EventRanking getEventRankings($event_key, $if_modified_since)

Gets a list of team rankings for the 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\EventApi(
    // 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->getEventRankings($event_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventApi->getEventRankings: ', $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\EventRanking

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]

getEventSimple

\TBAAPI\v3client\TBAAPI\v3client\model\EventSimple getEventSimple($event_key, $if_modified_since)

Gets a short-form 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\EventApi(
    // 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->getEventSimple($event_key, $if_modified_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventApi->getEventSimple: ', $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\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]

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

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

Files

EventApi.md

Latest commit

History

EventApi.md

File metadata and controls

TBAAPI\v3client\EventApi

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

getEvent

Example

Parameters

Return type

Authorization

HTTP request headers

getEventAlliances

Example

Parameters

Return type

Authorization

HTTP request headers

getEventAwards

Example

Parameters

Return type

Authorization

HTTP request headers

getEventDistrictPoints

Example

Parameters

Return type

Authorization

HTTP request headers

getEventInsights

Example

Parameters

Return type

Authorization

HTTP request headers

getEventMatchTimeseries

Example

Parameters

Return type

Authorization

HTTP request headers

getEventMatches

Example

Parameters

Return type

Authorization

HTTP request headers

getEventMatchesKeys

Example

Parameters

Return type

Authorization

HTTP request headers

getEventMatchesSimple

Example

Parameters

Return type

Authorization

HTTP request headers

getEventOPRs