All URIs are relative to https://www.thebluealliance.com/api/v3
| Method | HTTP request | Description |
|---|---|---|
| GetDistrictRankings | GET /district/{district_key}/rankings | |
| GetDistrictTeams | GET /district/{district_key}/teams | |
| GetDistrictTeamsKeys | GET /district/{district_key}/teams/keys | |
| GetDistrictTeamsSimple | GET /district/{district_key}/teams/simple | |
| GetEventTeams | GET /event/{event_key}/teams | |
| GetEventTeamsKeys | GET /event/{event_key}/teams/keys | |
| GetEventTeamsSimple | GET /event/{event_key}/teams/simple | |
| GetEventTeamsStatuses | GET /event/{event_key}/teams/statuses | |
| GetTeam | GET /team/{team_key} | |
| GetTeamAwards | GET /team/{team_key}/awards | |
| GetTeamAwardsByYear | GET /team/{team_key}/awards/{year} | |
| GetTeamDistricts | GET /team/{team_key}/districts | |
| GetTeamEventAwards | GET /team/{team_key}/event/{event_key}/awards | |
| GetTeamEventMatches | GET /team/{team_key}/event/{event_key}/matches | |
| GetTeamEventMatchesKeys | GET /team/{team_key}/event/{event_key}/matches/keys | |
| GetTeamEventMatchesSimple | GET /team/{team_key}/event/{event_key}/matches/simple | |
| GetTeamEventStatus | GET /team/{team_key}/event/{event_key}/status | |
| GetTeamEvents | GET /team/{team_key}/events | |
| GetTeamEventsByYear | GET /team/{team_key}/events/{year} | |
| GetTeamEventsByYearKeys | GET /team/{team_key}/events/{year}/keys | |
| GetTeamEventsByYearSimple | GET /team/{team_key}/events/{year}/simple | |
| GetTeamEventsKeys | GET /team/{team_key}/events/keys | |
| GetTeamEventsSimple | GET /team/{team_key}/events/simple | |
| GetTeamEventsStatusesByYear | GET /team/{team_key}/events/{year}/statuses | |
| GetTeamMatchesByYear | GET /team/{team_key}/matches/{year} | |
| GetTeamMatchesByYearKeys | GET /team/{team_key}/matches/{year}/keys | |
| GetTeamMatchesByYearSimple | GET /team/{team_key}/matches/{year}/simple | |
| GetTeamMediaByTag | GET /team/{team_key}/media/tag/{media_tag} | |
| GetTeamMediaByTagYear | GET /team/{team_key}/media/tag/{media_tag}/{year} | |
| GetTeamMediaByYear | GET /team/{team_key}/media/{year} | |
| GetTeamRobots | GET /team/{team_key}/robots | |
| GetTeamSimple | GET /team/{team_key}/simple | |
| GetTeamSocialMedia | GET /team/{team_key}/social_media | |
| GetTeamYearsParticipated | GET /team/{team_key}/years_participated | |
| GetTeams | GET /teams/{page_num} | |
| GetTeamsByYear | GET /teams/{year}/{page_num} | |
| GetTeamsByYearKeys | GET /teams/{year}/{page_num}/keys | |
| GetTeamsByYearSimple | GET /teams/{year}/{page_num}/simple | |
| GetTeamsKeys | GET /teams/{page_num}/keys | |
| GetTeamsSimple | GET /teams/{page_num}/simple |
List<DistrictRanking> GetDistrictRankings (string districtKey, string ifModifiedSince = null)
Gets a list of team district rankings for the given district.
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 GetDistrictRankingsExample
{
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 TeamApi(Configuration.Default);
var districtKey = districtKey_example; // string | TBA District Key, eg `2016fim`
var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
try
{
List<DistrictRanking> result = apiInstance.GetDistrictRankings(districtKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetDistrictRankings: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| districtKey | string | TBA District Key, eg `2016fim` | |
| ifModifiedSince | string | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<Team> GetDistrictTeams (string districtKey, string ifModifiedSince = null)
Gets a list of Team objects that competed in events in the given district.
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 GetDistrictTeamsExample
{
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 TeamApi(Configuration.Default);
var districtKey = districtKey_example; // string | TBA District Key, eg `2016fim`
var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
try
{
List<Team> result = apiInstance.GetDistrictTeams(districtKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetDistrictTeams: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| districtKey | string | TBA District Key, eg `2016fim` | |
| ifModifiedSince | string | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<string> GetDistrictTeamsKeys (string districtKey, string ifModifiedSince = null)
Gets a list of Team objects that competed in events in the given district.
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 GetDistrictTeamsKeysExample
{
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 TeamApi(Configuration.Default);
var districtKey = districtKey_example; // string | TBA District Key, eg `2016fim`
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.GetDistrictTeamsKeys(districtKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetDistrictTeamsKeys: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| districtKey | string | TBA District Key, eg `2016fim` | |
| ifModifiedSince | string | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
List
- Content-Type: Not defined
- Accept: application/json
| 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]
List<TeamSimple> GetDistrictTeamsSimple (string districtKey, string ifModifiedSince = null)
Gets a short-form list of Team objects that competed in events in the given district.
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 GetDistrictTeamsSimpleExample
{
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 TeamApi(Configuration.Default);
var districtKey = districtKey_example; // string | TBA District Key, eg `2016fim`
var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
try
{
List<TeamSimple> result = apiInstance.GetDistrictTeamsSimple(districtKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetDistrictTeamsSimple: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| districtKey | string | TBA District Key, eg `2016fim` | |
| ifModifiedSince | string | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<Team> GetEventTeams (string eventKey, string ifModifiedSince = null)
Gets a list of Team objects that competed in the given event.
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 GetEventTeamsExample
{
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 TeamApi(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<Team> result = apiInstance.GetEventTeams(eventKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetEventTeams: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| 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] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<string> GetEventTeamsKeys (string eventKey, string ifModifiedSince = null)
Gets a list of Team keys that competed in the given event.
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 GetEventTeamsKeysExample
{
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 TeamApi(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.GetEventTeamsKeys(eventKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetEventTeamsKeys: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| 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] |
List
- Content-Type: Not defined
- Accept: application/json
| 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]
List<TeamSimple> GetEventTeamsSimple (string eventKey, string ifModifiedSince = null)
Gets a short-form list of Team objects that competed in the given event.
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 GetEventTeamsSimpleExample
{
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 TeamApi(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<TeamSimple> result = apiInstance.GetEventTeamsSimple(eventKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetEventTeamsSimple: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| 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] |
- Content-Type: Not defined
- Accept: application/json
| 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]
Dictionary<string, TeamEventStatus> GetEventTeamsStatuses (string eventKey, string ifModifiedSince = null)
Gets a key-value list of the event statuses for teams competing at the given event.
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 GetEventTeamsStatusesExample
{
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 TeamApi(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
{
Dictionary<string, TeamEventStatus> result = apiInstance.GetEventTeamsStatuses(eventKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetEventTeamsStatuses: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| 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] |
Dictionary<string, TeamEventStatus>
- Content-Type: Not defined
- Accept: application/json
| 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]
Team GetTeam (string teamKey, string ifModifiedSince = null)
Gets a Team object for the team referenced by the given key.
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 GetTeamExample
{
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 TeamApi(Configuration.Default);
var teamKey = teamKey_example; // string | TBA Team Key, eg `frc254`
var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
try
{
Team result = apiInstance.GetTeam(teamKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeam: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| teamKey | string | TBA Team Key, eg `frc254` | |
| ifModifiedSince | string | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<Award> GetTeamAwards (string teamKey, string ifModifiedSince = null)
Gets a list of awards the given team has won.
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 GetTeamAwardsExample
{
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 TeamApi(Configuration.Default);
var teamKey = teamKey_example; // string | TBA Team Key, eg `frc254`
var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
try
{
List<Award> result = apiInstance.GetTeamAwards(teamKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamAwards: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| teamKey | string | TBA Team Key, eg `frc254` | |
| ifModifiedSince | string | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<Award> GetTeamAwardsByYear (string teamKey, int year, string ifModifiedSince = null)
Gets a list of awards the given team has won in a given year.
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 GetTeamAwardsByYearExample
{
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 TeamApi(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<Award> result = apiInstance.GetTeamAwardsByYear(teamKey, year, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamAwardsByYear: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| 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] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<DistrictList> GetTeamDistricts (string teamKey, string ifModifiedSince = null)
Gets an array of districts representing each year the team was in a district. Will return an empty array if the team was never in a district.
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 GetTeamDistrictsExample
{
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 TeamApi(Configuration.Default);
var teamKey = teamKey_example; // string | TBA Team Key, eg `frc254`
var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
try
{
List<DistrictList> result = apiInstance.GetTeamDistricts(teamKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamDistricts: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| teamKey | string | TBA Team Key, eg `frc254` | |
| ifModifiedSince | string | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<Award> GetTeamEventAwards (string teamKey, string eventKey, string ifModifiedSince = null)
Gets a list of awards the given team won at the given event.
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 GetTeamEventAwardsExample
{
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 TeamApi(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<Award> result = apiInstance.GetTeamEventAwards(teamKey, eventKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamEventAwards: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| 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] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<Match> GetTeamEventMatches (string teamKey, string eventKey, string ifModifiedSince = null)
Gets a list of matches for the given team and event.
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 TeamApi(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 TeamApi.GetTeamEventMatches: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| 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] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<string> GetTeamEventMatchesKeys (string teamKey, string eventKey, string ifModifiedSince = null)
Gets a list of match keys for matches for the given team and event.
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 TeamApi(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 TeamApi.GetTeamEventMatchesKeys: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| 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] |
List
- Content-Type: Not defined
- Accept: application/json
| 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]
List<Match> GetTeamEventMatchesSimple (string teamKey, string eventKey, string ifModifiedSince = null)
Gets a short-form list of matches for the given team and event.
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 TeamApi(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 TeamApi.GetTeamEventMatchesSimple: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| 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] |
- Content-Type: Not defined
- Accept: application/json
| 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]
TeamEventStatus GetTeamEventStatus (string teamKey, string eventKey, string ifModifiedSince = null)
Gets the competition rank and status of the team at the given event.
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 GetTeamEventStatusExample
{
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 TeamApi(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
{
TeamEventStatus result = apiInstance.GetTeamEventStatus(teamKey, eventKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamEventStatus: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| 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] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<Event> GetTeamEvents (string teamKey, string ifModifiedSince = null)
Gets a list of all events this team has competed at.
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 GetTeamEventsExample
{
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 TeamApi(Configuration.Default);
var teamKey = teamKey_example; // string | TBA Team Key, eg `frc254`
var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
try
{
List<Event> result = apiInstance.GetTeamEvents(teamKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamEvents: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| teamKey | string | TBA Team Key, eg `frc254` | |
| ifModifiedSince | string | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<Event> GetTeamEventsByYear (string teamKey, int year, string ifModifiedSince = null)
Gets a list of events this team has competed at in the given year.
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 GetTeamEventsByYearExample
{
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 TeamApi(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<Event> result = apiInstance.GetTeamEventsByYear(teamKey, year, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamEventsByYear: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| 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] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<string> GetTeamEventsByYearKeys (string teamKey, int year, string ifModifiedSince = null)
Gets a list of the event keys for events this team has competed at in the given year.
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 GetTeamEventsByYearKeysExample
{
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 TeamApi(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.GetTeamEventsByYearKeys(teamKey, year, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamEventsByYearKeys: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| 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] |
List
- Content-Type: Not defined
- Accept: application/json
| 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]
List<EventSimple> GetTeamEventsByYearSimple (string teamKey, int year, string ifModifiedSince = null)
Gets a short-form list of events this team has competed at in the given year.
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 GetTeamEventsByYearSimpleExample
{
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 TeamApi(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<EventSimple> result = apiInstance.GetTeamEventsByYearSimple(teamKey, year, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamEventsByYearSimple: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| 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] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<string> GetTeamEventsKeys (string teamKey, string ifModifiedSince = null)
Gets a list of the event keys for all events this team has competed at.
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 GetTeamEventsKeysExample
{
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 TeamApi(Configuration.Default);
var teamKey = teamKey_example; // string | TBA Team Key, eg `frc254`
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.GetTeamEventsKeys(teamKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamEventsKeys: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| teamKey | string | TBA Team Key, eg `frc254` | |
| ifModifiedSince | string | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
List
- Content-Type: Not defined
- Accept: application/json
| 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]
List<EventSimple> GetTeamEventsSimple (string teamKey, string ifModifiedSince = null)
Gets a short-form list of all events this team has competed at.
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 GetTeamEventsSimpleExample
{
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 TeamApi(Configuration.Default);
var teamKey = teamKey_example; // string | TBA Team Key, eg `frc254`
var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
try
{
List<EventSimple> result = apiInstance.GetTeamEventsSimple(teamKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamEventsSimple: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| teamKey | string | TBA Team Key, eg `frc254` | |
| ifModifiedSince | string | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| 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]
Dictionary<string, TeamEventStatus> GetTeamEventsStatusesByYear (string teamKey, int year, string ifModifiedSince = null)
Gets a key-value list of the event statuses for events this team has competed at in the given year.
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 GetTeamEventsStatusesByYearExample
{
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 TeamApi(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
{
Dictionary<string, TeamEventStatus> result = apiInstance.GetTeamEventsStatusesByYear(teamKey, year, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamEventsStatusesByYear: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| 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] |
Dictionary<string, TeamEventStatus>
- Content-Type: Not defined
- Accept: application/json
| 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]
List<Match> GetTeamMatchesByYear (string teamKey, int year, string ifModifiedSince = null)
Gets a list of matches for the given team and year.
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 TeamApi(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 TeamApi.GetTeamMatchesByYear: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| 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] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<string> GetTeamMatchesByYearKeys (string teamKey, int year, string ifModifiedSince = null)
Gets a list of match keys for matches for the given team and year.
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 TeamApi(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 TeamApi.GetTeamMatchesByYearKeys: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| 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] |
List
- Content-Type: Not defined
- Accept: application/json
| 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]
List<MatchSimple> GetTeamMatchesByYearSimple (string teamKey, int year, string ifModifiedSince = null)
Gets a short-form list of matches for the given team and year.
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 TeamApi(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 TeamApi.GetTeamMatchesByYearSimple: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| 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] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<Media> GetTeamMediaByTag (string teamKey, string mediaTag, string ifModifiedSince = null)
Gets a list of Media (videos / pictures) for the given team and tag.
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 GetTeamMediaByTagExample
{
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 TeamApi(Configuration.Default);
var teamKey = teamKey_example; // string | TBA Team Key, eg `frc254`
var mediaTag = mediaTag_example; // string | Media Tag which describes the Media.
var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
try
{
List<Media> result = apiInstance.GetTeamMediaByTag(teamKey, mediaTag, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamMediaByTag: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| teamKey | string | TBA Team Key, eg `frc254` | |
| mediaTag | string | Media Tag which describes the Media. | |
| ifModifiedSince | string | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<Media> GetTeamMediaByTagYear (string teamKey, string mediaTag, int year, string ifModifiedSince = null)
Gets a list of Media (videos / pictures) for the given team, tag and year.
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 GetTeamMediaByTagYearExample
{
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 TeamApi(Configuration.Default);
var teamKey = teamKey_example; // string | TBA Team Key, eg `frc254`
var mediaTag = mediaTag_example; // string | Media Tag which describes the Media.
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<Media> result = apiInstance.GetTeamMediaByTagYear(teamKey, mediaTag, year, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamMediaByTagYear: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| teamKey | string | TBA Team Key, eg `frc254` | |
| mediaTag | string | Media Tag which describes the Media. | |
| 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] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<Media> GetTeamMediaByYear (string teamKey, int year, string ifModifiedSince = null)
Gets a list of Media (videos / pictures) for the given team and year.
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 GetTeamMediaByYearExample
{
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 TeamApi(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<Media> result = apiInstance.GetTeamMediaByYear(teamKey, year, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamMediaByYear: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| 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] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<TeamRobot> GetTeamRobots (string teamKey, string ifModifiedSince = null)
Gets a list of year and robot name pairs for each year that a robot name was provided. Will return an empty array if the team has never named a robot.
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 GetTeamRobotsExample
{
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 TeamApi(Configuration.Default);
var teamKey = teamKey_example; // string | TBA Team Key, eg `frc254`
var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
try
{
List<TeamRobot> result = apiInstance.GetTeamRobots(teamKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamRobots: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| teamKey | string | TBA Team Key, eg `frc254` | |
| ifModifiedSince | string | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| 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]
TeamSimple GetTeamSimple (string teamKey, string ifModifiedSince = null)
Gets a Team_Simple object for the team referenced by the given key.
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 GetTeamSimpleExample
{
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 TeamApi(Configuration.Default);
var teamKey = teamKey_example; // string | TBA Team Key, eg `frc254`
var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
try
{
TeamSimple result = apiInstance.GetTeamSimple(teamKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamSimple: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| teamKey | string | TBA Team Key, eg `frc254` | |
| ifModifiedSince | string | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<Media> GetTeamSocialMedia (string teamKey, string ifModifiedSince = null)
Gets a list of Media (social media) for the given team.
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 GetTeamSocialMediaExample
{
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 TeamApi(Configuration.Default);
var teamKey = teamKey_example; // string | TBA Team Key, eg `frc254`
var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
try
{
List<Media> result = apiInstance.GetTeamSocialMedia(teamKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamSocialMedia: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| teamKey | string | TBA Team Key, eg `frc254` | |
| ifModifiedSince | string | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<int> GetTeamYearsParticipated (string teamKey, string ifModifiedSince = null)
Gets a list of years in which the team participated in at least one competition.
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 GetTeamYearsParticipatedExample
{
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 TeamApi(Configuration.Default);
var teamKey = teamKey_example; // string | TBA Team Key, eg `frc254`
var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
try
{
List<int> result = apiInstance.GetTeamYearsParticipated(teamKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamYearsParticipated: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| teamKey | string | TBA Team Key, eg `frc254` | |
| ifModifiedSince | string | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
List
- Content-Type: Not defined
- Accept: application/json
| 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]
List<Team> GetTeams (int pageNum, string ifModifiedSince = null)
Gets a list of Team objects, paginated in groups of 500.
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 GetTeamsExample
{
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 TeamApi(Configuration.Default);
var pageNum = 56; // int | Page number of results to return, zero-indexed
var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
try
{
List<Team> result = apiInstance.GetTeams(pageNum, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeams: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pageNum | int | Page number of results to return, zero-indexed | |
| ifModifiedSince | string | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<Team> GetTeamsByYear (int year, int pageNum, string ifModifiedSince = null)
Gets a list of Team objects that competed in the given year, paginated in groups of 500.
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 GetTeamsByYearExample
{
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 TeamApi(Configuration.Default);
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var pageNum = 56; // int | Page number of results to return, zero-indexed
var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
try
{
List<Team> result = apiInstance.GetTeamsByYear(year, pageNum, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamsByYear: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| year | int | Competition Year (or Season). Must be 4 digits. | |
| pageNum | int | Page number of results to return, zero-indexed | |
| ifModifiedSince | string | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<string> GetTeamsByYearKeys (int year, int pageNum, string ifModifiedSince = null)
Gets a list Team Keys that competed in the given year, paginated in groups of 500.
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 GetTeamsByYearKeysExample
{
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 TeamApi(Configuration.Default);
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var pageNum = 56; // int | Page number of results to return, zero-indexed
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.GetTeamsByYearKeys(year, pageNum, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamsByYearKeys: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| year | int | Competition Year (or Season). Must be 4 digits. | |
| pageNum | int | Page number of results to return, zero-indexed | |
| ifModifiedSince | string | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
List
- Content-Type: Not defined
- Accept: application/json
| 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]
List<TeamSimple> GetTeamsByYearSimple (int year, int pageNum, string ifModifiedSince = null)
Gets a list of short form Team_Simple objects that competed in the given year, paginated in groups of 500.
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 GetTeamsByYearSimpleExample
{
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 TeamApi(Configuration.Default);
var year = 56; // int | Competition Year (or Season). Must be 4 digits.
var pageNum = 56; // int | Page number of results to return, zero-indexed
var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
try
{
List<TeamSimple> result = apiInstance.GetTeamsByYearSimple(year, pageNum, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamsByYearSimple: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| year | int | Competition Year (or Season). Must be 4 digits. | |
| pageNum | int | Page number of results to return, zero-indexed | |
| ifModifiedSince | string | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| 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]
List<string> GetTeamsKeys (int pageNum, string ifModifiedSince = null)
Gets a list of Team keys, paginated in groups of 500. (Note, each page will not have 500 teams, but will include the teams within that range of 500.)
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 GetTeamsKeysExample
{
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 TeamApi(Configuration.Default);
var pageNum = 56; // int | Page number of results to return, zero-indexed
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.GetTeamsKeys(pageNum, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamsKeys: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pageNum | int | Page number of results to return, zero-indexed | |
| ifModifiedSince | string | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
List
- Content-Type: Not defined
- Accept: application/json
| 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]
List<TeamSimple> GetTeamsSimple (int pageNum, string ifModifiedSince = null)
Gets a list of short form Team_Simple objects, paginated in groups of 500.
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 GetTeamsSimpleExample
{
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 TeamApi(Configuration.Default);
var pageNum = 56; // int | Page number of results to return, zero-indexed
var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
try
{
List<TeamSimple> result = apiInstance.GetTeamsSimple(pageNum, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TeamApi.GetTeamsSimple: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pageNum | int | Page number of results to return, zero-indexed | |
| ifModifiedSince | string | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| 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]