Skip to content

Latest commit

 

History

History
716 lines (382 loc) · 22.4 KB

ListApi.md

File metadata and controls

716 lines (382 loc) · 22.4 KB

\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_insights_leaderboards_year GET /insights/leaderboards/{year}
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

Vecmodels::Event get_district_events(district_key, if_none_match)

Gets a list of events in the given district.

Parameters

Name Type Description Required Notes
district_key String TBA District Key, eg 2016fim [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

Vecmodels::Event

Authorization

apiKey

HTTP request headers

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

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

get_district_events_keys

Vec get_district_events_keys(district_key, if_none_match)

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

Parameters

Name Type Description Required Notes
district_key String TBA District Key, eg 2016fim [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

Vec

Authorization

apiKey

HTTP request headers

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

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

get_district_events_simple

Vecmodels::EventSimple get_district_events_simple(district_key, if_none_match)

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

Parameters

Name Type Description Required Notes
district_key String TBA District Key, eg 2016fim [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

Vecmodels::EventSimple

Authorization

apiKey

HTTP request headers

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

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

get_district_rankings

Vecmodels::DistrictRanking get_district_rankings(district_key, if_none_match)

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

Parameters

Name Type Description Required Notes
district_key String TBA District Key, eg 2016fim [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

Vecmodels::DistrictRanking

Authorization

apiKey

HTTP request headers

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

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

get_district_teams

Vecmodels::Team get_district_teams(district_key, if_none_match)

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

Parameters

Name Type Description Required Notes
district_key String TBA District Key, eg 2016fim [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

Vecmodels::Team

Authorization

apiKey

HTTP request headers

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

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

get_district_teams_keys

Vec get_district_teams_keys(district_key, if_none_match)

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

Parameters

Name Type Description Required Notes
district_key String TBA District Key, eg 2016fim [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

Vec

Authorization

apiKey

HTTP request headers

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

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

get_district_teams_simple

Vecmodels::TeamSimple get_district_teams_simple(district_key, if_none_match)

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

Parameters

Name Type Description Required Notes
district_key String TBA District Key, eg 2016fim [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

Vecmodels::TeamSimple

Authorization

apiKey

HTTP request headers

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

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

get_event_teams

Vecmodels::Team get_event_teams(event_key, if_none_match)

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

Parameters

Name Type Description Required Notes
event_key String TBA Event Key, eg 2016nytr [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

Vecmodels::Team

Authorization

apiKey

HTTP request headers

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

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

get_event_teams_keys

Vec get_event_teams_keys(event_key, if_none_match)

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

Parameters

Name Type Description Required Notes
event_key String TBA Event Key, eg 2016nytr [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

Vec

Authorization

apiKey

HTTP request headers

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

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

get_event_teams_simple

Vecmodels::TeamSimple get_event_teams_simple(event_key, if_none_match)

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

Parameters

Name Type Description Required Notes
event_key String TBA Event Key, eg 2016nytr [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

Vecmodels::TeamSimple

Authorization

apiKey

HTTP request headers

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

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

get_event_teams_statuses

std::collections::HashMap<String, models::GetTeamEventsStatusesByYear200ResponseValue> get_event_teams_statuses(event_key, if_none_match)

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

Parameters

Name Type Description Required Notes
event_key String TBA Event Key, eg 2016nytr [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

std::collections::HashMap<String, models::GetTeamEventsStatusesByYear200ResponseValue>

Authorization

apiKey

HTTP request headers

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

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

get_events_by_year

Vecmodels::Event get_events_by_year(year, if_none_match)

Gets a list of events in the given year.

Parameters

Name Type Description Required Notes
year i32 Competition Year (or Season). Must be 4 digits. [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

Vecmodels::Event

Authorization

apiKey

HTTP request headers

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

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

get_events_by_year_keys

Vec get_events_by_year_keys(year, if_none_match)

Gets a list of event keys in the given year.

Parameters

Name Type Description Required Notes
year i32 Competition Year (or Season). Must be 4 digits. [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

Vec

Authorization

apiKey

HTTP request headers

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

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

get_events_by_year_simple

Vecmodels::EventSimple get_events_by_year_simple(year, if_none_match)

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

Parameters

Name Type Description Required Notes
year i32 Competition Year (or Season). Must be 4 digits. [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

Vecmodels::EventSimple

Authorization

apiKey

HTTP request headers

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

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

get_insights_leaderboards_year

Vecmodels::LeaderboardInsight get_insights_leaderboards_year(year, if_none_match)

Gets a list of LeaderboardInsight objects from a specific year. Use year=0 for overall.

Parameters

Name Type Description Required Notes
year i32 Competition Year (or Season). Must be 4 digits. [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

Vecmodels::LeaderboardInsight

Authorization

apiKey

HTTP request headers

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

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

get_team_events_statuses_by_year

std::collections::HashMap<String, models::GetTeamEventsStatusesByYear200ResponseValue> get_team_events_statuses_by_year(team_key, year, if_none_match)

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

Parameters

Name Type Description Required Notes
team_key String TBA Team Key, eg frc254 [required]
year i32 Competition Year (or Season). Must be 4 digits. [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

std::collections::HashMap<String, models::GetTeamEventsStatusesByYear200ResponseValue>

Authorization

apiKey

HTTP request headers

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

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

get_teams

Vecmodels::Team get_teams(page_num, if_none_match)

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

Parameters

Name Type Description Required Notes
page_num i32 Page number of results to return, zero-indexed [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

Vecmodels::Team

Authorization

apiKey

HTTP request headers

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

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

get_teams_by_year

Vecmodels::Team get_teams_by_year(year, page_num, if_none_match)

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

Parameters

Name Type Description Required Notes
year i32 Competition Year (or Season). Must be 4 digits. [required]
page_num i32 Page number of results to return, zero-indexed [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

Vecmodels::Team

Authorization

apiKey

HTTP request headers

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

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

get_teams_by_year_keys

Vec get_teams_by_year_keys(year, page_num, if_none_match)

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

Parameters

Name Type Description Required Notes
year i32 Competition Year (or Season). Must be 4 digits. [required]
page_num i32 Page number of results to return, zero-indexed [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

Vec

Authorization

apiKey

HTTP request headers

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

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

get_teams_by_year_simple

Vecmodels::TeamSimple get_teams_by_year_simple(year, page_num, if_none_match)

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

Parameters

Name Type Description Required Notes
year i32 Competition Year (or Season). Must be 4 digits. [required]
page_num i32 Page number of results to return, zero-indexed [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

Vecmodels::TeamSimple

Authorization

apiKey

HTTP request headers

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

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

get_teams_keys

Vec get_teams_keys(page_num, if_none_match)

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

Parameters

Name Type Description Required Notes
page_num i32 Page number of results to return, zero-indexed [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

Vec

Authorization

apiKey

HTTP request headers

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

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

get_teams_simple

Vecmodels::TeamSimple get_teams_simple(page_num, if_none_match)

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

Parameters

Name Type Description Required Notes
page_num i32 Page number of results to return, zero-indexed [required]
if_none_match Option<String> Value of the ETag header in the most recently cached response by the client.

Return type

Vecmodels::TeamSimple

Authorization

apiKey

HTTP request headers

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

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