Skip to content

ListApi.md

Latest commit

 

History

History
1234 lines (831 loc) · 35.2 KB

ListApi.md

File metadata and controls

1234 lines (831 loc) · 35.2 KB

TBA API v3 Ruby Client::ListApi

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

Method HTTP request Description
get_district_events GET /district/{district_key}/events
get_district_events_keys GET /district/{district_key}/events/keys
get_district_events_simple GET /district/{district_key}/events/simple
get_district_rankings GET /district/{district_key}/rankings
get_district_teams GET /district/{district_key}/teams
get_district_teams_keys GET /district/{district_key}/teams/keys
get_district_teams_simple GET /district/{district_key}/teams/simple
get_event_teams GET /event/{event_key}/teams
get_event_teams_keys GET /event/{event_key}/teams/keys
get_event_teams_simple GET /event/{event_key}/teams/simple
get_event_teams_statuses GET /event/{event_key}/teams/statuses
get_events_by_year GET /events/{year}
get_events_by_year_keys GET /events/{year}/keys
get_events_by_year_simple GET /events/{year}/simple
get_team_events_statuses_by_year GET /team/{team_key}/events/{year}/statuses
get_teams GET /teams/{page_num}
get_teams_by_year GET /teams/{year}/{page_num}
get_teams_by_year_keys GET /teams/{year}/{page_num}/keys
get_teams_by_year_simple GET /teams/{year}/{page_num}/simple
get_teams_keys GET /teams/{page_num}/keys
get_teams_simple GET /teams/{page_num}/simple

get_district_events

Array<Event> get_district_events(district_key, opts)

Gets a list of events in the given district.

Example

# load the gem
require 'tba-api-v3client'
# setup authorization
TBA API v3 Ruby Client.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['X-TBA-Auth-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'
end

api_instance = TBA API v3 Ruby Client::ListApi.new
district_key = 'district_key_example' # String | TBA District Key, eg `2016fim`
opts = {
  if_modified_since: 'if_modified_since_example' # String | Value of the `Last-Modified` header in the most recently cached response by the client.
}

begin
  result = api_instance.get_district_events(district_key, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling ListApi->get_district_events: #{e}"
end

Parameters

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

Return type

Array<Event>

Authorization

apiKey

HTTP request headers

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

get_district_events_keys

Array<String> get_district_events_keys(district_key, opts)

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

Example

# load the gem
require 'tba-api-v3client'
# setup authorization
TBA API v3 Ruby Client.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['X-TBA-Auth-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'
end

api_instance = TBA API v3 Ruby Client::ListApi.new
district_key = 'district_key_example' # String | TBA District Key, eg `2016fim`
opts = {
  if_modified_since: 'if_modified_since_example' # String | Value of the `Last-Modified` header in the most recently cached response by the client.
}

begin
  result = api_instance.get_district_events_keys(district_key, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling ListApi->get_district_events_keys: #{e}"
end

Parameters

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

Return type

Array<String>

Authorization

apiKey

HTTP request headers

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

get_district_events_simple

Array<EventSimple> get_district_events_simple(district_key, opts)

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

Example

# load the gem
require 'tba-api-v3client'
# setup authorization
TBA API v3 Ruby Client.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['X-TBA-Auth-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'
end

api_instance = TBA API v3 Ruby Client::ListApi.new
district_key = 'district_key_example' # String | TBA District Key, eg `2016fim`
opts = {
  if_modified_since: 'if_modified_since_example' # String | Value of the `Last-Modified` header in the most recently cached response by the client.
}

begin
  result = api_instance.get_district_events_simple(district_key, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling ListApi->get_district_events_simple: #{e}"
end

Parameters

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

Return type

Array<EventSimple>

Authorization

apiKey

HTTP request headers

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

get_district_rankings

Array<DistrictRanking> get_district_rankings(district_key, opts)

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

Example

# load the gem
require 'tba-api-v3client'
# setup authorization
TBA API v3 Ruby Client.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['X-TBA-Auth-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'
end

api_instance = TBA API v3 Ruby Client::ListApi.new
district_key = 'district_key_example' # String | TBA District Key, eg `2016fim`
opts = {
  if_modified_since: 'if_modified_since_example' # String | Value of the `Last-Modified` header in the most recently cached response by the client.
}

begin
  result = api_instance.get_district_rankings(district_key, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling ListApi->get_district_rankings: #{e}"
end

Parameters

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

Return type

Array<DistrictRanking>

Authorization

apiKey

HTTP request headers

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

get_district_teams

Array<Team> get_district_teams(district_key, opts)

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

Example

# load the gem
require 'tba-api-v3client'
# setup authorization
TBA API v3 Ruby Client.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['X-TBA-Auth-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'
end

api_instance = TBA API v3 Ruby Client::ListApi.new
district_key = 'district_key_example' # String | TBA District Key, eg `2016fim`
opts = {
  if_modified_since: 'if_modified_since_example' # String | Value of the `Last-Modified` header in the most recently cached response by the client.
}

begin
  result = api_instance.get_district_teams(district_key, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling ListApi->get_district_teams: #{e}"
end

Parameters

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

Return type

Array<Team>

Authorization

apiKey

HTTP request headers

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

get_district_teams_keys

Array<String> get_district_teams_keys(district_key, opts)

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

Example

# load the gem
require 'tba-api-v3client'
# setup authorization
TBA API v3 Ruby Client.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['X-TBA-Auth-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'
end

api_instance = TBA API v3 Ruby Client::ListApi.new
district_key = 'district_key_example' # String | TBA District Key, eg `2016fim`
opts = {
  if_modified_since: 'if_modified_since_example' # String | Value of the `Last-Modified` header in the most recently cached response by the client.
}

begin
  result = api_instance.get_district_teams_keys(district_key, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling ListApi->get_district_teams_keys: #{e}"
end

Parameters

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

Return type

Array<String>

Authorization

apiKey

HTTP request headers

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

get_district_teams_simple

Array<TeamSimple> get_district_teams_simple(district_key, opts)

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

Example

# load the gem
require 'tba-api-v3client'
# setup authorization
TBA API v3 Ruby Client.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['X-TBA-Auth-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'
end

api_instance = TBA API v3 Ruby Client::ListApi.new
district_key = 'district_key_example' # String | TBA District Key, eg `2016fim`
opts = {
  if_modified_since: 'if_modified_since_example' # String | Value of the `Last-Modified` header in the most recently cached response by the client.
}

begin
  result = api_instance.get_district_teams_simple(district_key, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling ListApi->get_district_teams_simple: #{e}"
end

Parameters

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

Return type

Array<TeamSimple>

Authorization

apiKey

HTTP request headers

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

get_event_teams

Array<Team> get_event_teams(event_key, opts)

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

Example

# load the gem
require 'tba-api-v3client'
# setup authorization
TBA API v3 Ruby Client.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['X-TBA-Auth-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'
end

api_instance = TBA API v3 Ruby Client::ListApi.new
event_key = 'event_key_example' # String | TBA Event Key, eg `2016nytr`
opts = {
  if_modified_since: 'if_modified_since_example' # String | Value of the `Last-Modified` header in the most recently cached response by the client.
}

begin
  result = api_instance.get_event_teams(event_key, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling ListApi->get_event_teams: #{e}"
end

Parameters

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

Return type

Array<Team>

Authorization

apiKey

HTTP request headers

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

get_event_teams_keys

Array<String> get_event_teams_keys(event_key, opts)

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

Example

# load the gem
require 'tba-api-v3client'
# setup authorization
TBA API v3 Ruby Client.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['X-TBA-Auth-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'
end

api_instance = TBA API v3 Ruby Client::ListApi.new
event_key = 'event_key_example' # String | TBA Event Key, eg `2016nytr`
opts = {
  if_modified_since: 'if_modified_since_example' # String | Value of the `Last-Modified` header in the most recently cached response by the client.
}

begin
  result = api_instance.get_event_teams_keys(event_key, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling ListApi->get_event_teams_keys: #{e}"
end

Parameters

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

Return type

Array<String>

Authorization

apiKey

HTTP request headers

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

get_event_teams_simple

Array<TeamSimple> get_event_teams_simple(event_key, opts)

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

Example

# load the gem
require 'tba-api-v3client'
# setup authorization
TBA API v3 Ruby Client.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['X-TBA-Auth-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'
end

api_instance = TBA API v3 Ruby Client::ListApi.new
event_key = 'event_key_example' # String | TBA Event Key, eg `2016nytr`
opts = {
  if_modified_since: 'if_modified_since_example' # String | Value of the `Last-Modified` header in the most recently cached response by the client.
}

begin
  result = api_instance.get_event_teams_simple(event_key, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling ListApi->get_event_teams_simple: #{e}"
end

Parameters

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

Return type

Array<TeamSimple>

Authorization

apiKey

HTTP request headers

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

get_event_teams_statuses

Hash<String, TeamEventStatus> get_event_teams_statuses(event_key, opts)

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

Example

# load the gem
require 'tba-api-v3client'
# setup authorization
TBA API v3 Ruby Client.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['X-TBA-Auth-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'
end

api_instance = TBA API v3 Ruby Client::ListApi.new
event_key = 'event_key_example' # String | TBA Event Key, eg `2016nytr`
opts = {
  if_modified_since: 'if_modified_since_example' # String | Value of the `Last-Modified` header in the most recently cached response by the client.
}

begin
  result = api_instance.get_event_teams_statuses(event_key, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling ListApi->get_event_teams_statuses: #{e}"
end

Parameters

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

Return type

Hash<String, TeamEventStatus>

Authorization

apiKey

HTTP request headers

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

get_events_by_year

Array<Event> get_events_by_year(year, opts)

Gets a list of events in the given year.

Example

# load the gem
require 'tba-api-v3client'
# setup authorization
TBA API v3 Ruby Client.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['X-TBA-Auth-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'
end

api_instance = TBA API v3 Ruby Client::ListApi.new
year = 56 # Integer | Competition Year (or Season). Must be 4 digits.
opts = {
  if_modified_since: 'if_modified_since_example' # String | Value of the `Last-Modified` header in the most recently cached response by the client.
}

begin
  result = api_instance.get_events_by_year(year, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling ListApi->get_events_by_year: #{e}"
end

Parameters

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

Return type

Array<Event>

Authorization

apiKey

HTTP request headers

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

get_events_by_year_keys

Array<String> get_events_by_year_keys(year, opts)

Gets a list of event keys in the given year.

Example

# load the gem
require 'tba-api-v3client'
# setup authorization
TBA API v3 Ruby Client.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['X-TBA-Auth-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'
end

api_instance = TBA API v3 Ruby Client::ListApi.new
year = 56 # Integer | Competition Year (or Season). Must be 4 digits.
opts = {
  if_modified_since: 'if_modified_since_example' # String | Value of the `Last-Modified` header in the most recently cached response by the client.
}

begin
  result = api_instance.get_events_by_year_keys(year, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling ListApi->get_events_by_year_keys: #{e}"
end

Parameters

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

Return type

Array<String>

Authorization

apiKey

HTTP request headers

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

get_events_by_year_simple

Array<EventSimple> get_events_by_year_simple(year, opts)

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

Example

# load the gem
require 'tba-api-v3client'
# setup authorization
TBA API v3 Ruby Client.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['X-TBA-Auth-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'
end

api_instance = TBA API v3 Ruby Client::ListApi.new
year = 56 # Integer | Competition Year (or Season). Must be 4 digits.
opts = {
  if_modified_since: 'if_modified_since_example' # String | Value of the `Last-Modified` header in the most recently cached response by the client.
}

begin
  result = api_instance.get_events_by_year_simple(year, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling ListApi->get_events_by_year_simple: #{e}"
end

Parameters

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

Return type

Array<EventSimple>

Authorization

apiKey

HTTP request headers

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

get_team_events_statuses_by_year

Hash<String, TeamEventStatus> get_team_events_statuses_by_year(team_key, year, opts)

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

Example

# load the gem
require 'tba-api-v3client'
# setup authorization
TBA API v3 Ruby Client.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['X-TBA-Auth-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'
end

api_instance = TBA API v3 Ruby Client::ListApi.new
team_key = 'team_key_example' # String | TBA Team Key, eg `frc254`
year = 56 # Integer | Competition Year (or Season). Must be 4 digits.
opts = {
  if_modified_since: 'if_modified_since_example' # String | Value of the `Last-Modified` header in the most recently cached response by the client.
}

begin
  result = api_instance.get_team_events_statuses_by_year(team_key, year, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling ListApi->get_team_events_statuses_by_year: #{e}"
end

Parameters

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

Return type

Hash<String, TeamEventStatus>

Authorization

apiKey

HTTP request headers

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

get_teams

Array<Team> get_teams(page_num, opts)

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

Example

# load the gem
require 'tba-api-v3client'
# setup authorization
TBA API v3 Ruby Client.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['X-TBA-Auth-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'
end

api_instance = TBA API v3 Ruby Client::ListApi.new
page_num = 56 # Integer | Page number of results to return, zero-indexed
opts = {
  if_modified_since: 'if_modified_since_example' # String | Value of the `Last-Modified` header in the most recently cached response by the client.
}

begin
  result = api_instance.get_teams(page_num, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling ListApi->get_teams: #{e}"
end

Parameters

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

Return type

Array<Team>

Authorization

apiKey

HTTP request headers

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

get_teams_by_year

Array<Team> get_teams_by_year(year, page_num, opts)

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

Example

# load the gem
require 'tba-api-v3client'
# setup authorization
TBA API v3 Ruby Client.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['X-TBA-Auth-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'
end

api_instance = TBA API v3 Ruby Client::ListApi.new
year = 56 # Integer | Competition Year (or Season). Must be 4 digits.
page_num = 56 # Integer | Page number of results to return, zero-indexed
opts = {
  if_modified_since: 'if_modified_since_example' # String | Value of the `Last-Modified` header in the most recently cached response by the client.
}

begin
  result = api_instance.get_teams_by_year(year, page_num, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling ListApi->get_teams_by_year: #{e}"
end

Parameters

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

Return type

Array<Team>

Authorization

apiKey

HTTP request headers

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

get_teams_by_year_keys

Array<String> get_teams_by_year_keys(year, page_num, opts)

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

Example

# load the gem
require 'tba-api-v3client'
# setup authorization
TBA API v3 Ruby Client.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['X-TBA-Auth-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'
end

api_instance = TBA API v3 Ruby Client::ListApi.new
year = 56 # Integer | Competition Year (or Season). Must be 4 digits.
page_num = 56 # Integer | Page number of results to return, zero-indexed
opts = {
  if_modified_since: 'if_modified_since_example' # String | Value of the `Last-Modified` header in the most recently cached response by the client.
}

begin
  result = api_instance.get_teams_by_year_keys(year, page_num, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling ListApi->get_teams_by_year_keys: #{e}"
end

Parameters

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

Return type

Array<String>

Authorization

apiKey

HTTP request headers

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

get_teams_by_year_simple

Array<TeamSimple> get_teams_by_year_simple(year, page_num, opts)

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

Example

# load the gem
require 'tba-api-v3client'
# setup authorization
TBA API v3 Ruby Client.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['X-TBA-Auth-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'
end

api_instance = TBA API v3 Ruby Client::ListApi.new
year = 56 # Integer | Competition Year (or Season). Must be 4 digits.
page_num = 56 # Integer | Page number of results to return, zero-indexed
opts = {
  if_modified_since: 'if_modified_since_example' # String | Value of the `Last-Modified` header in the most recently cached response by the client.
}

begin
  result = api_instance.get_teams_by_year_simple(year, page_num, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling ListApi->get_teams_by_year_simple: #{e}"
end

Parameters

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

Return type

Array<TeamSimple>

Authorization

apiKey

HTTP request headers

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

get_teams_keys

Array<String> get_teams_keys(page_num, opts)

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

# load the gem
require 'tba-api-v3client'
# setup authorization
TBA API v3 Ruby Client.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['X-TBA-Auth-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'
end

api_instance = TBA API v3 Ruby Client::ListApi.new
page_num = 56 # Integer | Page number of results to return, zero-indexed
opts = {
  if_modified_since: 'if_modified_since_example' # String | Value of the `Last-Modified` header in the most recently cached response by the client.
}

begin
  result = api_instance.get_teams_keys(page_num, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling ListApi->get_teams_keys: #{e}"
end

Parameters

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

Return type

Array<String>

Authorization

apiKey

HTTP request headers

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

get_teams_simple

Array<TeamSimple> get_teams_simple(page_num, opts)

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

Example

# load the gem
require 'tba-api-v3client'
# setup authorization
TBA API v3 Ruby Client.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['X-TBA-Auth-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['X-TBA-Auth-Key'] = 'Bearer'
end

api_instance = TBA API v3 Ruby Client::ListApi.new
page_num = 56 # Integer | Page number of results to return, zero-indexed
opts = {
  if_modified_since: 'if_modified_since_example' # String | Value of the `Last-Modified` header in the most recently cached response by the client.
}

begin
  result = api_instance.get_teams_simple(page_num, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling ListApi->get_teams_simple: #{e}"
end

Parameters

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

Return type

Array<TeamSimple>

Authorization

apiKey

HTTP request headers

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