Skip to content

Latest commit

 

History

History
328 lines (174 loc) · 10.1 KB

DistrictApi.md

File metadata and controls

328 lines (174 loc) · 10.1 KB
Raw

\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_0 GET /event/{event_key}/district_points
get_team_districts_0 GET /team/{team_key}/districts

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_districts_by_year

Vecmodels::DistrictList get_districts_by_year(year, if_none_match)

Gets a list of districts and their corresponding district key, for 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::DistrictList

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_district_points_0

models::EventDistrictPoints get_event_district_points_0(event_key, if_none_match)

Gets a list of team rankings for the 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

models::EventDistrictPoints

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_districts_0

Vecmodels::DistrictList get_team_districts_0(team_key, if_none_match)

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.

Parameters

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

Return type

Vecmodels::DistrictList

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]