All URIs are relative to https://www.thebluealliance.com/api/v3
| Method | HTTP request | Description |
|---|---|---|
| GetDistrictEvents | GET /district/{district_key}/events | |
| GetDistrictEventsKeys | GET /district/{district_key}/events/keys | |
| GetDistrictEventsSimple | GET /district/{district_key}/events/simple | |
| GetEvent | GET /event/{event_key} | |
| GetEventAlliances | GET /event/{event_key}/alliances | |
| GetEventAwards | GET /event/{event_key}/awards | |
| GetEventDistrictPoints | GET /event/{event_key}/district_points | |
| GetEventInsights | GET /event/{event_key}/insights | |
| GetEventMatchTimeseries | GET /event/{event_key}/matches/timeseries | |
| GetEventMatches | GET /event/{event_key}/matches | |
| GetEventMatchesKeys | GET /event/{event_key}/matches/keys | |
| GetEventMatchesSimple | GET /event/{event_key}/matches/simple | |
| GetEventOPRs | GET /event/{event_key}/oprs | |
| GetEventPredictions | GET /event/{event_key}/predictions | |
| GetEventRankings | GET /event/{event_key}/rankings | |
| GetEventSimple | GET /event/{event_key}/simple | |
| GetEventTeams | GET /event/{event_key}/teams | |
| GetEventTeamsKeys | GET /event/{event_key}/teams/keys | |
| GetEventTeamsSimple | GET /event/{event_key}/teams/simple | |
| GetEventTeamsStatuses | GET /event/{event_key}/teams/statuses | |
| GetEventsByYear | GET /events/{year} | |
| GetEventsByYearKeys | GET /events/{year}/keys | |
| GetEventsByYearSimple | GET /events/{year}/simple | |
| GetTeamEventAwards | GET /team/{team_key}/event/{event_key}/awards | |
| GetTeamEventMatches | GET /team/{team_key}/event/{event_key}/matches | |
| GetTeamEventMatchesKeys | GET /team/{team_key}/event/{event_key}/matches/keys | |
| GetTeamEventMatchesSimple | GET /team/{team_key}/event/{event_key}/matches/simple | |
| GetTeamEventStatus | GET /team/{team_key}/event/{event_key}/status | |
| GetTeamEvents | GET /team/{team_key}/events | |
| GetTeamEventsByYear | GET /team/{team_key}/events/{year} | |
| GetTeamEventsByYearKeys | GET /team/{team_key}/events/{year}/keys | |
| GetTeamEventsByYearSimple | GET /team/{team_key}/events/{year}/simple | |
| GetTeamEventsKeys | GET /team/{team_key}/events/keys | |
| GetTeamEventsSimple | GET /team/{team_key}/events/simple | |
| GetTeamEventsStatusesByYear | GET /team/{team_key}/events/{year}/statuses |
List<Event> GetDistrictEvents (string districtKey, string ifModifiedSince = null)
Gets a list of events in the given district.
using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using TBAAPI.V3Client.Model;
namespace Example
{
public class GetDistrictEventsExample
{
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 EventApi(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<Event> result = apiInstance.GetDistrictEvents(districtKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventApi.GetDistrictEvents: " + 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> GetDistrictEventsKeys (string districtKey, string ifModifiedSince = null)
Gets a list of event keys for events in the given district.
using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using TBAAPI.V3Client.Model;
namespace Example
{
public class GetDistrictEventsKeysExample
{
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 EventApi(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.GetDistrictEventsKeys(districtKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventApi.GetDistrictEventsKeys: " + 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<EventSimple> GetDistrictEventsSimple (string districtKey, string ifModifiedSince = null)
Gets a short-form list of events in the given district.
using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using TBAAPI.V3Client.Model;
namespace Example
{
public class GetDistrictEventsSimpleExample
{
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 EventApi(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<EventSimple> result = apiInstance.GetDistrictEventsSimple(districtKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventApi.GetDistrictEventsSimple: " + 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]
Event GetEvent (string eventKey, string ifModifiedSince = null)
Gets an Event.
using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using TBAAPI.V3Client.Model;
namespace Example
{
public class GetEventExample
{
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 EventApi(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
{
Event result = apiInstance.GetEvent(eventKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventApi.GetEvent: " + 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<EliminationAlliance> GetEventAlliances (string eventKey, string ifModifiedSince = null)
Gets a list of Elimination Alliances for the given Event.
using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using TBAAPI.V3Client.Model;
namespace Example
{
public class GetEventAlliancesExample
{
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 EventApi(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<EliminationAlliance> result = apiInstance.GetEventAlliances(eventKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventApi.GetEventAlliances: " + 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<Award> GetEventAwards (string eventKey, string ifModifiedSince = null)
Gets a list of awards from the given event.
using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using TBAAPI.V3Client.Model;
namespace Example
{
public class GetEventAwardsExample
{
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 EventApi(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<Award> result = apiInstance.GetEventAwards(eventKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventApi.GetEventAwards: " + 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]
EventDistrictPoints GetEventDistrictPoints (string eventKey, string ifModifiedSince = null)
Gets a list of team rankings for the Event.
using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using TBAAPI.V3Client.Model;
namespace Example
{
public class GetEventDistrictPointsExample
{
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 EventApi(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
{
EventDistrictPoints result = apiInstance.GetEventDistrictPoints(eventKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventApi.GetEventDistrictPoints: " + 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]
EventInsights GetEventInsights (string eventKey, string ifModifiedSince = null)
Gets a set of Event-specific insights for the given Event.
using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using TBAAPI.V3Client.Model;
namespace Example
{
public class GetEventInsightsExample
{
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 EventApi(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
{
EventInsights result = apiInstance.GetEventInsights(eventKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventApi.GetEventInsights: " + 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> GetEventMatchTimeseries (string eventKey, string ifModifiedSince = null)
Gets an array of Match Keys for the given event key that have timeseries data. Returns an empty array if no matches have timeseries data. WARNING: This is not official data, and is subject to a significant possibility of error, or missing data. Do not rely on this data for any purpose. In fact, pretend we made it up. WARNING: This endpoint and corresponding data models are under active development and may change at any time, including in breaking ways.
using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using TBAAPI.V3Client.Model;
namespace Example
{
public class GetEventMatchTimeseriesExample
{
public static void Main()
{
Configuration.Default.BasePath = "https://www.thebluealliance.com/api/v3";
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("X-TBA-Auth-Key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("X-TBA-Auth-Key", "Bearer");
var apiInstance = new EventApi(Configuration.Default);
var eventKey = eventKey_example; // string | TBA Event Key, eg `2016nytr`
var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
try
{
List<string> result = apiInstance.GetEventMatchTimeseries(eventKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventApi.GetEventMatchTimeseries: " + 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<Match> GetEventMatches (string eventKey, string ifModifiedSince = null)
Gets a list of matches for the given event.
using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using TBAAPI.V3Client.Model;
namespace Example
{
public class GetEventMatchesExample
{
public static void Main()
{
Configuration.Default.BasePath = "https://www.thebluealliance.com/api/v3";
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("X-TBA-Auth-Key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("X-TBA-Auth-Key", "Bearer");
var apiInstance = new EventApi(Configuration.Default);
var eventKey = eventKey_example; // string | TBA Event Key, eg `2016nytr`
var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
try
{
List<Match> result = apiInstance.GetEventMatches(eventKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventApi.GetEventMatches: " + 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> GetEventMatchesKeys (string eventKey, string ifModifiedSince = null)
Gets a list of match keys for the given event.
using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using TBAAPI.V3Client.Model;
namespace Example
{
public class GetEventMatchesKeysExample
{
public static void Main()
{
Configuration.Default.BasePath = "https://www.thebluealliance.com/api/v3";
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("X-TBA-Auth-Key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("X-TBA-Auth-Key", "Bearer");
var apiInstance = new EventApi(Configuration.Default);
var eventKey = eventKey_example; // string | TBA Event Key, eg `2016nytr`
var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
try
{
List<string> result = apiInstance.GetEventMatchesKeys(eventKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventApi.GetEventMatchesKeys: " + 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<MatchSimple> GetEventMatchesSimple (string eventKey, string ifModifiedSince = null)
Gets a short-form list of matches for the given event.
using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using TBAAPI.V3Client.Model;
namespace Example
{
public class GetEventMatchesSimpleExample
{
public static void Main()
{
Configuration.Default.BasePath = "https://www.thebluealliance.com/api/v3";
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("X-TBA-Auth-Key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("X-TBA-Auth-Key", "Bearer");
var apiInstance = new EventApi(Configuration.Default);
var eventKey = eventKey_example; // string | TBA Event Key, eg `2016nytr`
var ifModifiedSince = ifModifiedSince_example; // string | Value of the `Last-Modified` header in the most recently cached response by the client. (optional)
try
{
List<MatchSimple> result = apiInstance.GetEventMatchesSimple(eventKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventApi.GetEventMatchesSimple: " + 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]
EventOPRs GetEventOPRs (string eventKey, string ifModifiedSince = null)
Gets a set of Event OPRs (including OPR, DPR, and CCWM) for the given Event.
using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using TBAAPI.V3Client.Model;
namespace Example
{
public class GetEventOPRsExample
{
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 EventApi(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
{
EventOPRs result = apiInstance.GetEventOPRs(eventKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventApi.GetEventOPRs: " + 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]
Object GetEventPredictions (string eventKey, string ifModifiedSince = null)
Gets information on TBA-generated predictions for the given Event. Contains year-specific information. WARNING This endpoint is currently under development and may change at any time.
using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using TBAAPI.V3Client.Model;
namespace Example
{
public class GetEventPredictionsExample
{
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 EventApi(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
{
Object result = apiInstance.GetEventPredictions(eventKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventApi.GetEventPredictions: " + 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] |
Object
- 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]
EventRanking GetEventRankings (string eventKey, string ifModifiedSince = null)
Gets a list of team rankings for the Event.
using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using TBAAPI.V3Client.Model;
namespace Example
{
public class GetEventRankingsExample
{
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 EventApi(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
{
EventRanking result = apiInstance.GetEventRankings(eventKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventApi.GetEventRankings: " + 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]
EventSimple GetEventSimple (string eventKey, string ifModifiedSince = null)
Gets a short-form Event.
using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using TBAAPI.V3Client.Model;
namespace Example
{
public class GetEventSimpleExample
{
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 EventApi(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
{
EventSimple result = apiInstance.GetEventSimple(eventKey, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventApi.GetEventSimple: " + 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<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 TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 EventApi(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 EventApi.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 TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 EventApi(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 EventApi.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 TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 EventApi(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 EventApi.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 TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 EventApi(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 EventApi.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]
List<Event> GetEventsByYear (int year, string ifModifiedSince = null)
Gets a list of events in the given year.
using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using TBAAPI.V3Client.Model;
namespace Example
{
public class GetEventsByYearExample
{
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 EventApi(Configuration.Default);
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.GetEventsByYear(year, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventApi.GetEventsByYear: " + 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. | |
| 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> GetEventsByYearKeys (int year, string ifModifiedSince = null)
Gets a list of event keys in the given year.
using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using TBAAPI.V3Client.Model;
namespace Example
{
public class GetEventsByYearKeysExample
{
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 EventApi(Configuration.Default);
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.GetEventsByYearKeys(year, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventApi.GetEventsByYearKeys: " + 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. | |
| 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> GetEventsByYearSimple (int year, string ifModifiedSince = null)
Gets a short-form list of events in the given year.
using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using TBAAPI.V3Client.Model;
namespace Example
{
public class GetEventsByYearSimpleExample
{
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 EventApi(Configuration.Default);
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.GetEventsByYearSimple(year, ifModifiedSince);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling EventApi.GetEventsByYearSimple: " + 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. | |
| 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 TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 EventApi(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 EventApi.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 TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 EventApi(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 EventApi.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 TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 EventApi(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 EventApi.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 TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 EventApi(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 EventApi.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 TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 EventApi(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 EventApi.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 TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 EventApi(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 EventApi.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 TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 EventApi(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 EventApi.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 TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 EventApi(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 EventApi.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 TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 EventApi(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 EventApi.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 TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 EventApi(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 EventApi.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 TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 EventApi(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 EventApi.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 TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 EventApi(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 EventApi.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]