ListApi.md

TBAAPI.V3Client.Api.ListApi

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

Method	HTTP request	Description
GetDistrictEvents	GET /district/{district_key}/events
GetDistrictEventsKeys	GET /district/{district_key}/events/keys
GetDistrictEventsSimple	GET /district/{district_key}/events/simple
GetDistrictRankings	GET /district/{district_key}/rankings
GetDistrictTeams	GET /district/{district_key}/teams
GetDistrictTeamsKeys	GET /district/{district_key}/teams/keys
GetDistrictTeamsSimple	GET /district/{district_key}/teams/simple
GetEventTeams	GET /event/{event_key}/teams
GetEventTeamsKeys	GET /event/{event_key}/teams/keys
GetEventTeamsSimple	GET /event/{event_key}/teams/simple
GetEventTeamsStatuses	GET /event/{event_key}/teams/statuses
GetEventsByYear	GET /events/{year}
GetEventsByYearKeys	GET /events/{year}/keys
GetEventsByYearSimple	GET /events/{year}/simple
GetTeamEventsStatusesByYear	GET /team/{team_key}/events/{year}/statuses
GetTeams	GET /teams/{page_num}
GetTeamsByYear	GET /teams/{year}/{page_num}
GetTeamsByYearKeys	GET /teams/{year}/{page_num}/keys
GetTeamsByYearSimple	GET /teams/{year}/{page_num}/simple
GetTeamsKeys	GET /teams/{page_num}/keys
GetTeamsSimple	GET /teams/{page_num}/simple

GetDistrictEvents

List<Event> GetDistrictEvents (string districtKey, string ifModifiedSince = null)

Gets a list of events in the given district.

Example

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 ListApi(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 ListApi.GetDistrictEvents: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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]

Return type

List<Event>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

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

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

GetDistrictEventsKeys

List<string> GetDistrictEventsKeys (string districtKey, string ifModifiedSince = null)

Gets a list of event keys for events in the given district.

Example

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 ListApi(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 ListApi.GetDistrictEventsKeys: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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]

Return type

List

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

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

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

GetDistrictEventsSimple

List<EventSimple> GetDistrictEventsSimple (string districtKey, string ifModifiedSince = null)

Gets a short-form list of events in the given district.

Example

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 ListApi(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 ListApi.GetDistrictEventsSimple: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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]

Return type

List<EventSimple>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

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

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

GetDistrictRankings

List<DistrictRanking> GetDistrictRankings (string districtKey, string ifModifiedSince = null)

Gets a list of team district rankings for the given district.

Example

using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 ListApi(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 ListApi.GetDistrictRankings: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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]

Return type

List<DistrictRanking>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

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

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

GetDistrictTeams

List<Team> GetDistrictTeams (string districtKey, string ifModifiedSince = null)

Gets a list of Team objects that competed in events in the given district.

Example

using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 ListApi(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 ListApi.GetDistrictTeams: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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]

Return type

List<Team>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

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

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

GetDistrictTeamsKeys

List<string> GetDistrictTeamsKeys (string districtKey, string ifModifiedSince = null)

Gets a list of Team objects that competed in events in the given district.

Example

using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 ListApi(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 ListApi.GetDistrictTeamsKeys: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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]

Return type

List

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

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

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

GetDistrictTeamsSimple

List<TeamSimple> GetDistrictTeamsSimple (string districtKey, string ifModifiedSince = null)

Gets a short-form list of Team objects that competed in events in the given district.

Example

using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 ListApi(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 ListApi.GetDistrictTeamsSimple: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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]

Return type

List<TeamSimple>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

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

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

GetEventTeams

List<Team> GetEventTeams (string eventKey, string ifModifiedSince = null)

Gets a list of Team objects that competed in the given event.

Example

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 ListApi(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 ListApi.GetEventTeams: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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

Return type

List<Team>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

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

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

GetEventTeamsKeys

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

Gets a list of Team keys that competed in the given event.

Example

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 ListApi(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 ListApi.GetEventTeamsKeys: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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

Return type

List

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

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

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

GetEventTeamsSimple

List<TeamSimple> GetEventTeamsSimple (string eventKey, string ifModifiedSince = null)

Gets a short-form list of Team objects that competed in the given event.

Example

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 ListApi(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 ListApi.GetEventTeamsSimple: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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

Return type

List<TeamSimple>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

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

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

GetEventTeamsStatuses

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.

Example

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 ListApi(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 ListApi.GetEventTeamsStatuses: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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

Return type

Dictionary<string, TeamEventStatus>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

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

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

GetEventsByYear

List<Event> GetEventsByYear (int year, string ifModifiedSince = null)

Gets a list of events in the given year.

Example

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 ListApi(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 ListApi.GetEventsByYear: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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]

Return type

List<Event>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

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

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

GetEventsByYearKeys

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

Gets a list of event keys in the given year.

Example

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 ListApi(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 ListApi.GetEventsByYearKeys: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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]

Return type

List

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

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

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

GetEventsByYearSimple

List<EventSimple> GetEventsByYearSimple (int year, string ifModifiedSince = null)

Gets a short-form list of events in the given year.

Example

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 ListApi(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 ListApi.GetEventsByYearSimple: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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]

Return type

List<EventSimple>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

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

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

GetTeamEventsStatusesByYear

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.

Example

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 ListApi(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 ListApi.GetTeamEventsStatusesByYear: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
teamKey	string	TBA Team Key, eg `frc254`
year	int	Competition Year (or Season). Must be 4 digits.
ifModifiedSince	string	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

Dictionary<string, TeamEventStatus>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

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

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

GetTeams

List<Team> GetTeams (int pageNum, string ifModifiedSince = null)

Gets a list of Team objects, paginated in groups of 500.

Example

using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 ListApi(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 ListApi.GetTeams: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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]

Return type

List<Team>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

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

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

GetTeamsByYear

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.

Example

using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 ListApi(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 ListApi.GetTeamsByYear: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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]

Return type

List<Team>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

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

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

GetTeamsByYearKeys

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.

Example

using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 ListApi(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 ListApi.GetTeamsByYearKeys: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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]

Return type

List

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

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

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

GetTeamsByYearSimple

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.

Example

using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 ListApi(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 ListApi.GetTeamsByYearSimple: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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]

Return type

List<TeamSimple>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

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

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

GetTeamsKeys

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.)

Example

using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 ListApi(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 ListApi.GetTeamsKeys: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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]

Return type

List

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

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

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

GetTeamsSimple

List<TeamSimple> GetTeamsSimple (int pageNum, string ifModifiedSince = null)

Gets a list of short form Team_Simple objects, paginated in groups of 500.

Example

using System.Collections.Generic;
using System.Diagnostics;
using TBAAPI.V3Client.Api;
using TBAAPI.V3Client.Client;
using 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 ListApi(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 ListApi.GetTeamsSimple: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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]

Return type

List<TeamSimple>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

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

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