TBA API v3 Ruby Client::DistrictApi

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_districts_by_year	GET /districts/{year}
get_event_district_points	GET /event/{event_key}/district_points
get_team_districts	GET /team/{team_key}/districts

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::DistrictApi.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 DistrictApi->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::DistrictApi.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 DistrictApi->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::DistrictApi.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 DistrictApi->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::DistrictApi.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 DistrictApi->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::DistrictApi.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 DistrictApi->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::DistrictApi.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 DistrictApi->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::DistrictApi.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 DistrictApi->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_districts_by_year

Array<DistrictList> get_districts_by_year(year, opts)

Gets a list of districts and their corresponding district key, for 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::DistrictApi.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_districts_by_year(year, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling DistrictApi->get_districts_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<DistrictList>

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_event_district_points

EventDistrictPoints get_event_district_points(event_key, opts)

Gets a list of team rankings for the 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::DistrictApi.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_district_points(event_key, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling DistrictApi->get_event_district_points: #{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

EventDistrictPoints

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_team_districts

Array<DistrictList> get_team_districts(team_key, opts)

Gets an array of districts representing each year the team was in a district. Will return an empty array if the team was never in a district.

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::DistrictApi.new
team_key = 'team_key_example' # String | TBA Team Key, eg `frc254`
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_districts(team_key, opts)
  p result
rescue TBA API v3 Ruby Client::ApiError => e
  puts "Exception when calling DistrictApi->get_team_districts: #{e}"
end

Parameters

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

Return type

Array<DistrictList>

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

FilesExpand file tree

DistrictApi.md

Latest commit

History

DistrictApi.md

File metadata and controls

TBA API v3 Ruby Client::DistrictApi

get_district_events

Example

Parameters

Return type

Authorization

HTTP request headers

get_district_events_keys

Example

Parameters

Return type

Authorization

HTTP request headers

get_district_events_simple

Example

Parameters

Return type

Authorization

HTTP request headers

get_district_rankings

Example

Parameters

Return type

Authorization

HTTP request headers

get_district_teams

Example

Parameters

Return type

Authorization

HTTP request headers

get_district_teams_keys

Example

Parameters

Return type

Authorization

HTTP request headers

get_district_teams_simple

Example

Parameters

Return type

Authorization

HTTP request headers

get_districts_by_year

Example

Parameters

Return type

Authorization

HTTP request headers

get_event_district_points

Example

Parameters

Return type

Authorization

HTTP request headers

get_team_districts

Example

Parameters

Return type

Authorization

HTTP request headers