net.thefletcher.tbaapi.v3client.Api.MatchApi

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

Method	HTTP request	Description
GetEventMatchTimeseries	GET /event/{event_key}/matches/timeseries
GetEventMatches	GET /event/{event_key}/matches
GetEventMatchesKeys	GET /event/{event_key}/matches/keys
GetEventMatchesSimple	GET /event/{event_key}/matches/simple
GetMatch	GET /match/{match_key}
GetMatchSimple	GET /match/{match_key}/simple
GetMatchTimeseries	GET /match/{match_key}/timeseries
GetMatchZebra	GET /match/{match_key}/zebra_motionworks
GetTeamEventMatches	GET /team/{team_key}/event/{event_key}/matches
GetTeamEventMatchesKeys	GET /team/{team_key}/event/{event_key}/matches/keys
GetTeamEventMatchesSimple	GET /team/{team_key}/event/{event_key}/matches/simple
GetTeamMatchesByYear	GET /team/{team_key}/matches/{year}
GetTeamMatchesByYearKeys	GET /team/{team_key}/matches/{year}/keys
GetTeamMatchesByYearSimple	GET /team/{team_key}/matches/{year}/simple

GetEventMatchTimeseries

List<string> GetEventMatchTimeseries (string eventKey, string ifModifiedSince = null)

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

using System.Collections.Generic;
using System.Diagnostics;
using net.thefletcher.tbaapi.v3client.Api;
using net.thefletcher.tbaapi.v3client.Client;
using net.thefletcher.tbaapi.v3client.Model;

namespace Example
{
    public class GetEventMatchTimeseriesExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://www.thebluealliance.com/api/v3";
            // Configure API key authorization: apiKey
            Configuration.Default.AddApiKey("X-TBA-Auth-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-TBA-Auth-Key", "Bearer");

            var apiInstance = new MatchApi(Configuration.Default);
            var eventKey = eventKey_example;  // string | TBA Event Key, eg `2016nytr`
            var ifModifiedSince = ifModifiedSince_example;  // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional) 

            try
            {
                List<string> result = apiInstance.GetEventMatchTimeseries(eventKey, ifModifiedSince);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling MatchApi.GetEventMatchTimeseries: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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

Return type

List

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	* Cache-Control - The `Cache-Control` header, in particular the `max-age` value, contains the number of seconds the result should be considered valid for. During this time subsequent calls should return from the local cache directly. * Last-Modified - Indicates the date and time the data returned was last updated. Used by clients in the `If-Modified-Since` request header.
304	Not Modified - Use Local Cached Value	-
401		-

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

GetEventMatches

List<Match> GetEventMatches (string eventKey, string ifModifiedSince = null)

Gets a list of matches for the given event.

Example

using System.Collections.Generic;
using System.Diagnostics;
using net.thefletcher.tbaapi.v3client.Api;
using net.thefletcher.tbaapi.v3client.Client;
using net.thefletcher.tbaapi.v3client.Model;

namespace Example
{
    public class GetEventMatchesExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://www.thebluealliance.com/api/v3";
            // Configure API key authorization: apiKey
            Configuration.Default.AddApiKey("X-TBA-Auth-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-TBA-Auth-Key", "Bearer");

            var apiInstance = new MatchApi(Configuration.Default);
            var eventKey = eventKey_example;  // string | TBA Event Key, eg `2016nytr`
            var ifModifiedSince = ifModifiedSince_example;  // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional) 

            try
            {
                List<Match> result = apiInstance.GetEventMatches(eventKey, ifModifiedSince);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling MatchApi.GetEventMatches: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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

Return type

List<Match>

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	* Cache-Control - The `Cache-Control` header, in particular the `max-age` value, contains the number of seconds the result should be considered valid for. During this time subsequent calls should return from the local cache directly. * Last-Modified - Indicates the date and time the data returned was last updated. Used by clients in the `If-Modified-Since` request header.
304	Not Modified - Use Local Cached Value	-
401		-

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

GetEventMatchesKeys

List<string> GetEventMatchesKeys (string eventKey, string ifModifiedSince = null)

Gets a list of match keys for the given event.

Example

using System.Collections.Generic;
using System.Diagnostics;
using net.thefletcher.tbaapi.v3client.Api;
using net.thefletcher.tbaapi.v3client.Client;
using net.thefletcher.tbaapi.v3client.Model;

namespace Example
{
    public class GetEventMatchesKeysExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://www.thebluealliance.com/api/v3";
            // Configure API key authorization: apiKey
            Configuration.Default.AddApiKey("X-TBA-Auth-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-TBA-Auth-Key", "Bearer");

            var apiInstance = new MatchApi(Configuration.Default);
            var eventKey = eventKey_example;  // string | TBA Event Key, eg `2016nytr`
            var ifModifiedSince = ifModifiedSince_example;  // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional) 

            try
            {
                List<string> result = apiInstance.GetEventMatchesKeys(eventKey, ifModifiedSince);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling MatchApi.GetEventMatchesKeys: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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

Return type

List

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	* Cache-Control - The `Cache-Control` header, in particular the `max-age` value, contains the number of seconds the result should be considered valid for. During this time subsequent calls should return from the local cache directly. * Last-Modified - Indicates the date and time the data returned was last updated. Used by clients in the `If-Modified-Since` request header.
304	Not Modified - Use Local Cached Value	-
401		-

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

GetEventMatchesSimple

List<MatchSimple> GetEventMatchesSimple (string eventKey, string ifModifiedSince = null)

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using net.thefletcher.tbaapi.v3client.Api;
using net.thefletcher.tbaapi.v3client.Client;
using net.thefletcher.tbaapi.v3client.Model;

namespace Example
{
    public class GetEventMatchesSimpleExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://www.thebluealliance.com/api/v3";
            // Configure API key authorization: apiKey
            Configuration.Default.AddApiKey("X-TBA-Auth-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-TBA-Auth-Key", "Bearer");

            var apiInstance = new MatchApi(Configuration.Default);
            var eventKey = eventKey_example;  // string | TBA Event Key, eg `2016nytr`
            var ifModifiedSince = ifModifiedSince_example;  // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional) 

            try
            {
                List<MatchSimple> result = apiInstance.GetEventMatchesSimple(eventKey, ifModifiedSince);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling MatchApi.GetEventMatchesSimple: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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

Return type

List<MatchSimple>

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	* Cache-Control - The `Cache-Control` header, in particular the `max-age` value, contains the number of seconds the result should be considered valid for. During this time subsequent calls should return from the local cache directly. * Last-Modified - Indicates the date and time the data returned was last updated. Used by clients in the `If-Modified-Since` request header.
304	Not Modified - Use Local Cached Value	-
401		-

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

GetMatch

Match GetMatch (string matchKey, string ifModifiedSince = null)

Gets a Match object for the given match key.

Example

using System.Collections.Generic;
using System.Diagnostics;
using net.thefletcher.tbaapi.v3client.Api;
using net.thefletcher.tbaapi.v3client.Client;
using net.thefletcher.tbaapi.v3client.Model;

namespace Example
{
    public class GetMatchExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://www.thebluealliance.com/api/v3";
            // Configure API key authorization: apiKey
            Configuration.Default.AddApiKey("X-TBA-Auth-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-TBA-Auth-Key", "Bearer");

            var apiInstance = new MatchApi(Configuration.Default);
            var matchKey = matchKey_example;  // string | TBA Match Key, eg `2016nytr_qm1`
            var ifModifiedSince = ifModifiedSince_example;  // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional) 

            try
            {
                Match result = apiInstance.GetMatch(matchKey, ifModifiedSince);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling MatchApi.GetMatch: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
matchKey	string	TBA Match Key, eg `2016nytr_qm1`
ifModifiedSince	string	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

Match

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	* Cache-Control - The `Cache-Control` header, in particular the `max-age` value, contains the number of seconds the result should be considered valid for. During this time subsequent calls should return from the local cache directly. * Last-Modified - Indicates the date and time the data returned was last updated. Used by clients in the `If-Modified-Since` request header.
304	Not Modified - Use Local Cached Value	-
401		-

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

GetMatchSimple

MatchSimple GetMatchSimple (string matchKey, string ifModifiedSince = null)

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using net.thefletcher.tbaapi.v3client.Api;
using net.thefletcher.tbaapi.v3client.Client;
using net.thefletcher.tbaapi.v3client.Model;

namespace Example
{
    public class GetMatchSimpleExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://www.thebluealliance.com/api/v3";
            // Configure API key authorization: apiKey
            Configuration.Default.AddApiKey("X-TBA-Auth-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-TBA-Auth-Key", "Bearer");

            var apiInstance = new MatchApi(Configuration.Default);
            var matchKey = matchKey_example;  // string | TBA Match Key, eg `2016nytr_qm1`
            var ifModifiedSince = ifModifiedSince_example;  // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional) 

            try
            {
                MatchSimple result = apiInstance.GetMatchSimple(matchKey, ifModifiedSince);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling MatchApi.GetMatchSimple: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
matchKey	string	TBA Match Key, eg `2016nytr_qm1`
ifModifiedSince	string	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

MatchSimple

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	* Cache-Control - The `Cache-Control` header, in particular the `max-age` value, contains the number of seconds the result should be considered valid for. During this time subsequent calls should return from the local cache directly. * Last-Modified - Indicates the date and time the data returned was last updated. Used by clients in the `If-Modified-Since` request header.
304	Not Modified - Use Local Cached Value	-
401		-

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

GetMatchTimeseries

List<Object> GetMatchTimeseries (string matchKey, string ifModifiedSince = null)

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using net.thefletcher.tbaapi.v3client.Api;
using net.thefletcher.tbaapi.v3client.Client;
using net.thefletcher.tbaapi.v3client.Model;

namespace Example
{
    public class GetMatchTimeseriesExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://www.thebluealliance.com/api/v3";
            // Configure API key authorization: apiKey
            Configuration.Default.AddApiKey("X-TBA-Auth-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("X-TBA-Auth-Key", "Bearer");

            var apiInstance = new MatchApi(Configuration.Default);
            var matchKey = matchKey_example;  // string | TBA Match Key, eg `2016nytr_qm1`
            var ifModifiedSince = ifModifiedSince_example;  // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional) 

            try
            {
                List<Object> result = apiInstance.GetMatchTimeseries(matchKey, ifModifiedSince);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling MatchApi.GetMatchTimeseries: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
matchKey	string	TBA Match Key, eg `2016nytr_qm1`
ifModifiedSince	string	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

List

Authorization

apiKey

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 Successful response * Cache-Control - The `Cache-Control` header, in particular the `max-age` value, contains the number of seconds the result should be considered valid for. During this time subsequent calls should return from the local cache directly.
* Last-Modified - Indicates the date and time the data returned was last updated. Used by clients in the `If-Modified-Since` request header.

304 Not Modified - Use Local Cached Value -

401 -

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

GetMatchZebra

Zebra GetMatchZebra (string matchKey, string ifModifiedSince = null)

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

Example

using System.Collections.Generic; using System.Diagnostics; using net.thefletcher.tbaapi.v3client.Api; using net.thefletcher.tbaapi.v3client.Client; using net.thefletcher.tbaapi.v3client.Model; namespace Example { public class GetMatchZebraExample { public static void Main() { Configuration.Default.BasePath = "https://www.thebluealliance.com/api/v3"; // Configure API key authorization: apiKey Configuration.Default.AddApiKey("X-TBA-Auth-Key", "YOUR_API_KEY"); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("X-TBA-Auth-Key", "Bearer"); var apiInstance = new MatchApi(Configuration.Default); var matchKey = matchKey_example; // string | TBA Match Key, eg `2016nytr_qm1` var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional) try { Zebra result = apiInstance.GetMatchZebra(matchKey, ifModifiedSince); Debug.WriteLine(result); } catch (ApiException e) { Debug.Print("Exception when calling MatchApi.GetMatchZebra: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

matchKey string TBA Match Key, eg `2016nytr_qm1`

ifModifiedSince string Value of the `Last-Modified` header in the most recently cached response by the client. [optional]

Return type

Zebra

Authorization

apiKey

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 Successful response * Cache-Control - The `Cache-Control` header, in particular the `max-age` value, contains the number of seconds the result should be considered valid for. During this time subsequent calls should return from the local cache directly.
* Last-Modified - Indicates the date and time the data returned was last updated. Used by clients in the `If-Modified-Since` request header.

304 Not Modified - Use Local Cached Value -

401 -

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

GetTeamEventMatches

List<Match> GetTeamEventMatches (string teamKey, string eventKey, string ifModifiedSince = null)

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

Example

using System.Collections.Generic; using System.Diagnostics; using net.thefletcher.tbaapi.v3client.Api; using net.thefletcher.tbaapi.v3client.Client; using net.thefletcher.tbaapi.v3client.Model; namespace Example { public class GetTeamEventMatchesExample { public static void Main() { Configuration.Default.BasePath = "https://www.thebluealliance.com/api/v3"; // Configure API key authorization: apiKey Configuration.Default.AddApiKey("X-TBA-Auth-Key", "YOUR_API_KEY"); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("X-TBA-Auth-Key", "Bearer"); var apiInstance = new MatchApi(Configuration.Default); var teamKey = teamKey_example; // string | TBA Team Key, eg `frc254` var eventKey = eventKey_example; // string | TBA Event Key, eg `2016nytr` var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional) try { List<Match> result = apiInstance.GetTeamEventMatches(teamKey, eventKey, ifModifiedSince); Debug.WriteLine(result); } catch (ApiException e) { Debug.Print("Exception when calling MatchApi.GetTeamEventMatches: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

teamKey string TBA Team Key, eg `frc254`

eventKey string TBA Event Key, eg `2016nytr`

ifModifiedSince string Value of the `Last-Modified` header in the most recently cached response by the client. [optional]

Return type

List<Match>

Authorization

apiKey

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 Successful response * Cache-Control - The `Cache-Control` header, in particular the `max-age` value, contains the number of seconds the result should be considered valid for. During this time subsequent calls should return from the local cache directly.
* Last-Modified - Indicates the date and time the data returned was last updated. Used by clients in the `If-Modified-Since` request header.

304 Not Modified - Use Local Cached Value -

401 -

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

GetTeamEventMatchesKeys

List<string> GetTeamEventMatchesKeys (string teamKey, string eventKey, string ifModifiedSince = null)

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

Example

using System.Collections.Generic; using System.Diagnostics; using net.thefletcher.tbaapi.v3client.Api; using net.thefletcher.tbaapi.v3client.Client; using net.thefletcher.tbaapi.v3client.Model; namespace Example { public class GetTeamEventMatchesKeysExample { public static void Main() { Configuration.Default.BasePath = "https://www.thebluealliance.com/api/v3"; // Configure API key authorization: apiKey Configuration.Default.AddApiKey("X-TBA-Auth-Key", "YOUR_API_KEY"); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("X-TBA-Auth-Key", "Bearer"); var apiInstance = new MatchApi(Configuration.Default); var teamKey = teamKey_example; // string | TBA Team Key, eg `frc254` var eventKey = eventKey_example; // string | TBA Event Key, eg `2016nytr` var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional) try { List<string> result = apiInstance.GetTeamEventMatchesKeys(teamKey, eventKey, ifModifiedSince); Debug.WriteLine(result); } catch (ApiException e) { Debug.Print("Exception when calling MatchApi.GetTeamEventMatchesKeys: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

teamKey string TBA Team Key, eg `frc254`

eventKey string TBA Event Key, eg `2016nytr`

ifModifiedSince string Value of the `Last-Modified` header in the most recently cached response by the client. [optional]

Return type

List

Authorization

apiKey

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 Successful response * Cache-Control - The `Cache-Control` header, in particular the `max-age` value, contains the number of seconds the result should be considered valid for. During this time subsequent calls should return from the local cache directly.
* Last-Modified - Indicates the date and time the data returned was last updated. Used by clients in the `If-Modified-Since` request header.

304 Not Modified - Use Local Cached Value -

401 -

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

GetTeamEventMatchesSimple

List<Match> GetTeamEventMatchesSimple (string teamKey, string eventKey, string ifModifiedSince = null)

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

Example

using System.Collections.Generic; using System.Diagnostics; using net.thefletcher.tbaapi.v3client.Api; using net.thefletcher.tbaapi.v3client.Client; using net.thefletcher.tbaapi.v3client.Model; namespace Example { public class GetTeamEventMatchesSimpleExample { public static void Main() { Configuration.Default.BasePath = "https://www.thebluealliance.com/api/v3"; // Configure API key authorization: apiKey Configuration.Default.AddApiKey("X-TBA-Auth-Key", "YOUR_API_KEY"); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("X-TBA-Auth-Key", "Bearer"); var apiInstance = new MatchApi(Configuration.Default); var teamKey = teamKey_example; // string | TBA Team Key, eg `frc254` var eventKey = eventKey_example; // string | TBA Event Key, eg `2016nytr` var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional) try { List<Match> result = apiInstance.GetTeamEventMatchesSimple(teamKey, eventKey, ifModifiedSince); Debug.WriteLine(result); } catch (ApiException e) { Debug.Print("Exception when calling MatchApi.GetTeamEventMatchesSimple: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

teamKey string TBA Team Key, eg `frc254`

eventKey string TBA Event Key, eg `2016nytr`

ifModifiedSince string Value of the `Last-Modified` header in the most recently cached response by the client. [optional]

Return type

List<Match>

Authorization

apiKey

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 Successful response * Cache-Control - The `Cache-Control` header, in particular the `max-age` value, contains the number of seconds the result should be considered valid for. During this time subsequent calls should return from the local cache directly.
* Last-Modified - Indicates the date and time the data returned was last updated. Used by clients in the `If-Modified-Since` request header.

304 Not Modified - Use Local Cached Value -

401 -

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

GetTeamMatchesByYear

List<Match> GetTeamMatchesByYear (string teamKey, int year, string ifModifiedSince = null)

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

Example

using System.Collections.Generic; using System.Diagnostics; using net.thefletcher.tbaapi.v3client.Api; using net.thefletcher.tbaapi.v3client.Client; using net.thefletcher.tbaapi.v3client.Model; namespace Example { public class GetTeamMatchesByYearExample { public static void Main() { Configuration.Default.BasePath = "https://www.thebluealliance.com/api/v3"; // Configure API key authorization: apiKey Configuration.Default.AddApiKey("X-TBA-Auth-Key", "YOUR_API_KEY"); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("X-TBA-Auth-Key", "Bearer"); var apiInstance = new MatchApi(Configuration.Default); var teamKey = teamKey_example; // string | TBA Team Key, eg `frc254` var year = 56; // int | Competition Year (or Season). Must be 4 digits. var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional) try { List<Match> result = apiInstance.GetTeamMatchesByYear(teamKey, year, ifModifiedSince); Debug.WriteLine(result); } catch (ApiException e) { Debug.Print("Exception when calling MatchApi.GetTeamMatchesByYear: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

teamKey string TBA Team Key, eg `frc254`

year int Competition Year (or Season). Must be 4 digits.

ifModifiedSince string Value of the `Last-Modified` header in the most recently cached response by the client. [optional]

Return type

List<Match>

Authorization

apiKey

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 Successful response * Cache-Control - The `Cache-Control` header, in particular the `max-age` value, contains the number of seconds the result should be considered valid for. During this time subsequent calls should return from the local cache directly.
* Last-Modified - Indicates the date and time the data returned was last updated. Used by clients in the `If-Modified-Since` request header.

304 Not Modified - Use Local Cached Value -

401 -

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

GetTeamMatchesByYearKeys

List<string> GetTeamMatchesByYearKeys (string teamKey, int year, string ifModifiedSince = null)

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

Example

using System.Collections.Generic; using System.Diagnostics; using net.thefletcher.tbaapi.v3client.Api; using net.thefletcher.tbaapi.v3client.Client; using net.thefletcher.tbaapi.v3client.Model; namespace Example { public class GetTeamMatchesByYearKeysExample { public static void Main() { Configuration.Default.BasePath = "https://www.thebluealliance.com/api/v3"; // Configure API key authorization: apiKey Configuration.Default.AddApiKey("X-TBA-Auth-Key", "YOUR_API_KEY"); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("X-TBA-Auth-Key", "Bearer"); var apiInstance = new MatchApi(Configuration.Default); var teamKey = teamKey_example; // string | TBA Team Key, eg `frc254` var year = 56; // int | Competition Year (or Season). Must be 4 digits. var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional) try { List<string> result = apiInstance.GetTeamMatchesByYearKeys(teamKey, year, ifModifiedSince); Debug.WriteLine(result); } catch (ApiException e) { Debug.Print("Exception when calling MatchApi.GetTeamMatchesByYearKeys: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

teamKey string TBA Team Key, eg `frc254`

year int Competition Year (or Season). Must be 4 digits.

ifModifiedSince string Value of the `Last-Modified` header in the most recently cached response by the client. [optional]

Return type

List

Authorization

apiKey

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 Successful response * Cache-Control - The `Cache-Control` header, in particular the `max-age` value, contains the number of seconds the result should be considered valid for. During this time subsequent calls should return from the local cache directly.
* Last-Modified - Indicates the date and time the data returned was last updated. Used by clients in the `If-Modified-Since` request header.

304 Not Modified - Use Local Cached Value -

401 -

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

GetTeamMatchesByYearSimple

List<MatchSimple> GetTeamMatchesByYearSimple (string teamKey, int year, string ifModifiedSince = null)

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

Example

using System.Collections.Generic; using System.Diagnostics; using net.thefletcher.tbaapi.v3client.Api; using net.thefletcher.tbaapi.v3client.Client; using net.thefletcher.tbaapi.v3client.Model; namespace Example { public class GetTeamMatchesByYearSimpleExample { public static void Main() { Configuration.Default.BasePath = "https://www.thebluealliance.com/api/v3"; // Configure API key authorization: apiKey Configuration.Default.AddApiKey("X-TBA-Auth-Key", "YOUR_API_KEY"); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // Configuration.Default.AddApiKeyPrefix("X-TBA-Auth-Key", "Bearer"); var apiInstance = new MatchApi(Configuration.Default); var teamKey = teamKey_example; // string | TBA Team Key, eg `frc254` var year = 56; // int | Competition Year (or Season). Must be 4 digits. var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional) try { List<MatchSimple> result = apiInstance.GetTeamMatchesByYearSimple(teamKey, year, ifModifiedSince); Debug.WriteLine(result); } catch (ApiException e) { Debug.Print("Exception when calling MatchApi.GetTeamMatchesByYearSimple: " + e.Message ); Debug.Print("Status Code: "+ e.ErrorCode); Debug.Print(e.StackTrace); } } } }

Parameters

Name Type Description Notes

teamKey string TBA Team Key, eg `frc254`

year int Competition Year (or Season). Must be 4 digits.

ifModifiedSince string Value of the `Last-Modified` header in the most recently cached response by the client. [optional]

Return type

List<MatchSimple>

Authorization

apiKey

HTTP request headers

Content-Type: Not defined

Accept: application/json

HTTP response details

Status code Description Response headers

200 Successful response * Cache-Control - The `Cache-Control` header, in particular the `max-age` value, contains the number of seconds the result should be considered valid for. During this time subsequent calls should return from the local cache directly.
* Last-Modified - Indicates the date and time the data returned was last updated. Used by clients in the `If-Modified-Since` request header.

304 Not Modified - Use Local Cached Value -

401 -

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

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

Files

MatchApi.md

Latest commit

History

MatchApi.md

File metadata and controls

net.thefletcher.tbaapi.v3client.Api.MatchApi

GetEventMatchTimeseries

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetEventMatches

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetEventMatchesKeys

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetEventMatchesSimple

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetMatch

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetMatchSimple

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetMatchTimeseries

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetMatchZebra

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetTeamEventMatches

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetTeamEventMatchesKeys

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetTeamEventMatchesSimple

Example

Parameters