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

kotlin.Array<Event> getDistrictEvents(districtKey, ifMinusModifiedMinusSince)

Gets a list of events in the given district.

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*

val apiInstance = ListApi()
val districtKey : kotlin.String = districtKey_example // kotlin.String | TBA District Key, eg `2016fim`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    val result : kotlin.Array<Event> = apiInstance.getDistrictEvents(districtKey, ifMinusModifiedMinusSince)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ListApi#getDistrictEvents")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ListApi#getDistrictEvents")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
districtKey	kotlin.String	TBA District Key, eg `2016fim`
ifMinusModifiedMinusSince	kotlin.String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

kotlin.Array<Event>

Authorization

Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

getDistrictEventsKeys

kotlin.Array<kotlin.String> getDistrictEventsKeys(districtKey, ifMinusModifiedMinusSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*

val apiInstance = ListApi()
val districtKey : kotlin.String = districtKey_example // kotlin.String | TBA District Key, eg `2016fim`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    val result : kotlin.Array<kotlin.String> = apiInstance.getDistrictEventsKeys(districtKey, ifMinusModifiedMinusSince)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ListApi#getDistrictEventsKeys")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ListApi#getDistrictEventsKeys")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
districtKey	kotlin.String	TBA District Key, eg `2016fim`
ifMinusModifiedMinusSince	kotlin.String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

kotlin.Array<kotlin.String>

Authorization

Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

getDistrictEventsSimple

kotlin.Array<EventSimple> getDistrictEventsSimple(districtKey, ifMinusModifiedMinusSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*

val apiInstance = ListApi()
val districtKey : kotlin.String = districtKey_example // kotlin.String | TBA District Key, eg `2016fim`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    val result : kotlin.Array<EventSimple> = apiInstance.getDistrictEventsSimple(districtKey, ifMinusModifiedMinusSince)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ListApi#getDistrictEventsSimple")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ListApi#getDistrictEventsSimple")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
districtKey	kotlin.String	TBA District Key, eg `2016fim`
ifMinusModifiedMinusSince	kotlin.String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

kotlin.Array<EventSimple>

Authorization

Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

getDistrictRankings

kotlin.Array<DistrictRanking> getDistrictRankings(districtKey, ifMinusModifiedMinusSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*

val apiInstance = ListApi()
val districtKey : kotlin.String = districtKey_example // kotlin.String | TBA District Key, eg `2016fim`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    val result : kotlin.Array<DistrictRanking> = apiInstance.getDistrictRankings(districtKey, ifMinusModifiedMinusSince)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ListApi#getDistrictRankings")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ListApi#getDistrictRankings")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
districtKey	kotlin.String	TBA District Key, eg `2016fim`
ifMinusModifiedMinusSince	kotlin.String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

kotlin.Array<DistrictRanking>

Authorization

Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

getDistrictTeams

kotlin.Array<Team> getDistrictTeams(districtKey, ifMinusModifiedMinusSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*

val apiInstance = ListApi()
val districtKey : kotlin.String = districtKey_example // kotlin.String | TBA District Key, eg `2016fim`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    val result : kotlin.Array<Team> = apiInstance.getDistrictTeams(districtKey, ifMinusModifiedMinusSince)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ListApi#getDistrictTeams")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ListApi#getDistrictTeams")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
districtKey	kotlin.String	TBA District Key, eg `2016fim`
ifMinusModifiedMinusSince	kotlin.String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

kotlin.Array<Team>

Authorization

Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

getDistrictTeamsKeys

kotlin.Array<kotlin.String> getDistrictTeamsKeys(districtKey, ifMinusModifiedMinusSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*

val apiInstance = ListApi()
val districtKey : kotlin.String = districtKey_example // kotlin.String | TBA District Key, eg `2016fim`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    val result : kotlin.Array<kotlin.String> = apiInstance.getDistrictTeamsKeys(districtKey, ifMinusModifiedMinusSince)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ListApi#getDistrictTeamsKeys")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ListApi#getDistrictTeamsKeys")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
districtKey	kotlin.String	TBA District Key, eg `2016fim`
ifMinusModifiedMinusSince	kotlin.String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

kotlin.Array<kotlin.String>

Authorization

Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

getDistrictTeamsSimple

kotlin.Array<TeamSimple> getDistrictTeamsSimple(districtKey, ifMinusModifiedMinusSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*

val apiInstance = ListApi()
val districtKey : kotlin.String = districtKey_example // kotlin.String | TBA District Key, eg `2016fim`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    val result : kotlin.Array<TeamSimple> = apiInstance.getDistrictTeamsSimple(districtKey, ifMinusModifiedMinusSince)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ListApi#getDistrictTeamsSimple")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ListApi#getDistrictTeamsSimple")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
districtKey	kotlin.String	TBA District Key, eg `2016fim`
ifMinusModifiedMinusSince	kotlin.String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

kotlin.Array<TeamSimple>

Authorization

Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

getEventTeams

kotlin.Array<Team> getEventTeams(eventKey, ifMinusModifiedMinusSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*

val apiInstance = ListApi()
val eventKey : kotlin.String = eventKey_example // kotlin.String | TBA Event Key, eg `2016nytr`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    val result : kotlin.Array<Team> = apiInstance.getEventTeams(eventKey, ifMinusModifiedMinusSince)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ListApi#getEventTeams")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ListApi#getEventTeams")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.Array<Team>

Authorization

Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

getEventTeamsKeys

kotlin.Array<kotlin.String> getEventTeamsKeys(eventKey, ifMinusModifiedMinusSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*

val apiInstance = ListApi()
val eventKey : kotlin.String = eventKey_example // kotlin.String | TBA Event Key, eg `2016nytr`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    val result : kotlin.Array<kotlin.String> = apiInstance.getEventTeamsKeys(eventKey, ifMinusModifiedMinusSince)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ListApi#getEventTeamsKeys")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ListApi#getEventTeamsKeys")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.Array<kotlin.String>

Authorization

Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

getEventTeamsSimple

kotlin.Array<TeamSimple> getEventTeamsSimple(eventKey, ifMinusModifiedMinusSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*

val apiInstance = ListApi()
val eventKey : kotlin.String = eventKey_example // kotlin.String | TBA Event Key, eg `2016nytr`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    val result : kotlin.Array<TeamSimple> = apiInstance.getEventTeamsSimple(eventKey, ifMinusModifiedMinusSince)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ListApi#getEventTeamsSimple")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ListApi#getEventTeamsSimple")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.Array<TeamSimple>

Authorization

Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

getEventTeamsStatuses

kotlin.collections.Map<kotlin.String, TeamEventStatus> getEventTeamsStatuses(eventKey, ifMinusModifiedMinusSince)

Gets a key-value list of the event statuses for teams competing at the given event.

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*

val apiInstance = ListApi()
val eventKey : kotlin.String = eventKey_example // kotlin.String | TBA Event Key, eg `2016nytr`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    val result : kotlin.collections.Map<kotlin.String, TeamEventStatus> = apiInstance.getEventTeamsStatuses(eventKey, ifMinusModifiedMinusSince)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ListApi#getEventTeamsStatuses")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ListApi#getEventTeamsStatuses")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.collections.Map<kotlin.String, TeamEventStatus>

Authorization

Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

getEventsByYear

kotlin.Array<Event> getEventsByYear(year, ifMinusModifiedMinusSince)

Gets a list of events in the given year.

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*

val apiInstance = ListApi()
val year : kotlin.Int = 56 // kotlin.Int | Competition Year (or Season). Must be 4 digits.
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    val result : kotlin.Array<Event> = apiInstance.getEventsByYear(year, ifMinusModifiedMinusSince)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ListApi#getEventsByYear")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ListApi#getEventsByYear")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
year	kotlin.Int	Competition Year (or Season). Must be 4 digits.
ifMinusModifiedMinusSince	kotlin.String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

kotlin.Array<Event>

Authorization

Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

getEventsByYearKeys

kotlin.Array<kotlin.String> getEventsByYearKeys(year, ifMinusModifiedMinusSince)

Gets a list of event keys in the given year.

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*

val apiInstance = ListApi()
val year : kotlin.Int = 56 // kotlin.Int | Competition Year (or Season). Must be 4 digits.
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    val result : kotlin.Array<kotlin.String> = apiInstance.getEventsByYearKeys(year, ifMinusModifiedMinusSince)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ListApi#getEventsByYearKeys")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ListApi#getEventsByYearKeys")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
year	kotlin.Int	Competition Year (or Season). Must be 4 digits.
ifMinusModifiedMinusSince	kotlin.String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

kotlin.Array<kotlin.String>

Authorization

Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

getEventsByYearSimple

kotlin.Array<EventSimple> getEventsByYearSimple(year, ifMinusModifiedMinusSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*

val apiInstance = ListApi()
val year : kotlin.Int = 56 // kotlin.Int | Competition Year (or Season). Must be 4 digits.
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    val result : kotlin.Array<EventSimple> = apiInstance.getEventsByYearSimple(year, ifMinusModifiedMinusSince)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ListApi#getEventsByYearSimple")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ListApi#getEventsByYearSimple")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
year	kotlin.Int	Competition Year (or Season). Must be 4 digits.
ifMinusModifiedMinusSince	kotlin.String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

kotlin.Array<EventSimple>

Authorization

Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

getTeamEventsStatusesByYear

kotlin.collections.Map<kotlin.String, TeamEventStatus> getTeamEventsStatusesByYear(teamKey, year, ifMinusModifiedMinusSince)

Gets a key-value list of the event statuses for events this team has competed at in the given year.

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*

val apiInstance = ListApi()
val teamKey : kotlin.String = teamKey_example // kotlin.String | TBA Team Key, eg `frc254`
val year : kotlin.Int = 56 // kotlin.Int | Competition Year (or Season). Must be 4 digits.
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    val result : kotlin.collections.Map<kotlin.String, TeamEventStatus> = apiInstance.getTeamEventsStatusesByYear(teamKey, year, ifMinusModifiedMinusSince)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ListApi#getTeamEventsStatusesByYear")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ListApi#getTeamEventsStatusesByYear")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.collections.Map<kotlin.String, TeamEventStatus>

Authorization

Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

getTeams

kotlin.Array<Team> getTeams(pageNum, ifMinusModifiedMinusSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*

val apiInstance = ListApi()
val pageNum : kotlin.Int = 56 // kotlin.Int | Page number of results to return, zero-indexed
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    val result : kotlin.Array<Team> = apiInstance.getTeams(pageNum, ifMinusModifiedMinusSince)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ListApi#getTeams")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ListApi#getTeams")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
pageNum	kotlin.Int	Page number of results to return, zero-indexed
ifMinusModifiedMinusSince	kotlin.String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

kotlin.Array<Team>

Authorization

Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

getTeamsByYear

kotlin.Array<Team> getTeamsByYear(year, pageNum, ifMinusModifiedMinusSince)

Gets a list of `Team` objects that competed in the given year, paginated in groups of 500.

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*

val apiInstance = ListApi()
val year : kotlin.Int = 56 // kotlin.Int | Competition Year (or Season). Must be 4 digits.
val pageNum : kotlin.Int = 56 // kotlin.Int | Page number of results to return, zero-indexed
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    val result : kotlin.Array<Team> = apiInstance.getTeamsByYear(year, pageNum, ifMinusModifiedMinusSince)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ListApi#getTeamsByYear")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ListApi#getTeamsByYear")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
year	kotlin.Int	Competition Year (or Season). Must be 4 digits.
pageNum	kotlin.Int	Page number of results to return, zero-indexed
ifMinusModifiedMinusSince	kotlin.String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

kotlin.Array<Team>

Authorization

Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

getTeamsByYearKeys

kotlin.Array<kotlin.String> getTeamsByYearKeys(year, pageNum, ifMinusModifiedMinusSince)

Gets a list Team Keys that competed in the given year, paginated in groups of 500.

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*

val apiInstance = ListApi()
val year : kotlin.Int = 56 // kotlin.Int | Competition Year (or Season). Must be 4 digits.
val pageNum : kotlin.Int = 56 // kotlin.Int | Page number of results to return, zero-indexed
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    val result : kotlin.Array<kotlin.String> = apiInstance.getTeamsByYearKeys(year, pageNum, ifMinusModifiedMinusSince)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ListApi#getTeamsByYearKeys")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ListApi#getTeamsByYearKeys")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
year	kotlin.Int	Competition Year (or Season). Must be 4 digits.
pageNum	kotlin.Int	Page number of results to return, zero-indexed
ifMinusModifiedMinusSince	kotlin.String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

kotlin.Array<kotlin.String>

Authorization

Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

getTeamsByYearSimple

kotlin.Array<TeamSimple> getTeamsByYearSimple(year, pageNum, ifMinusModifiedMinusSince)

Gets a list of short form `Team_Simple` objects that competed in the given year, paginated in groups of 500.

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*

val apiInstance = ListApi()
val year : kotlin.Int = 56 // kotlin.Int | Competition Year (or Season). Must be 4 digits.
val pageNum : kotlin.Int = 56 // kotlin.Int | Page number of results to return, zero-indexed
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    val result : kotlin.Array<TeamSimple> = apiInstance.getTeamsByYearSimple(year, pageNum, ifMinusModifiedMinusSince)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ListApi#getTeamsByYearSimple")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ListApi#getTeamsByYearSimple")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
year	kotlin.Int	Competition Year (or Season). Must be 4 digits.
pageNum	kotlin.Int	Page number of results to return, zero-indexed
ifMinusModifiedMinusSince	kotlin.String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

kotlin.Array<TeamSimple>

Authorization

Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

getTeamsKeys

kotlin.Array<kotlin.String> getTeamsKeys(pageNum, ifMinusModifiedMinusSince)

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

// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*

val apiInstance = ListApi()
val pageNum : kotlin.Int = 56 // kotlin.Int | Page number of results to return, zero-indexed
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    val result : kotlin.Array<kotlin.String> = apiInstance.getTeamsKeys(pageNum, ifMinusModifiedMinusSince)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ListApi#getTeamsKeys")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ListApi#getTeamsKeys")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
pageNum	kotlin.Int	Page number of results to return, zero-indexed
ifMinusModifiedMinusSince	kotlin.String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

kotlin.Array<kotlin.String>

Authorization

Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

getTeamsSimple

kotlin.Array<TeamSimple> getTeamsSimple(pageNum, ifMinusModifiedMinusSince)

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

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*

val apiInstance = ListApi()
val pageNum : kotlin.Int = 56 // kotlin.Int | Page number of results to return, zero-indexed
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    val result : kotlin.Array<TeamSimple> = apiInstance.getTeamsSimple(pageNum, ifMinusModifiedMinusSince)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ListApi#getTeamsSimple")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ListApi#getTeamsSimple")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
pageNum	kotlin.Int	Page number of results to return, zero-indexed
ifMinusModifiedMinusSince	kotlin.String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

kotlin.Array<TeamSimple>

Authorization

Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

Files

ListApi.md

Latest commit

History

ListApi.md

File metadata and controls

ListApi

getDistrictEvents

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictEventsKeys

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictEventsSimple

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictRankings

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictTeams

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictTeamsKeys

Example

Parameters

Return type

Authorization

HTTP request headers

getDistrictTeamsSimple

Example

Parameters

Return type

Authorization

HTTP request headers

getEventTeams

Example

Parameters

Return type

Authorization

HTTP request headers

getEventTeamsKeys

Example

Parameters

Return type

Authorization

HTTP request headers

getEventTeamsSimple

Example

Parameters

Return type

Authorization

HTTP request headers

getEventTeamsStatuses

Example

Parameters

Return type

Authorization

HTTP request headers

getEventsByYear

Example

Parameters

Return type

Authorization

HTTP request headers

getEventsByYearKeys