Skip to content

Latest commit

 

History

History
462 lines (248 loc) · 14.9 KB

MatchApi.md

File metadata and controls

462 lines (248 loc) · 14.9 KB
Raw

\MatchApi

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

Method HTTP request Description
get_event_match_timeseries GET /event/{event_key}/matches/timeseries
get_event_matches GET /event/{event_key}/matches
get_event_matches_keys GET /event/{event_key}/matches/keys
get_event_matches_simple GET /event/{event_key}/matches/simple
get_match GET /match/{match_key}
get_match_simple GET /match/{match_key}/simple
get_match_timeseries GET /match/{match_key}/timeseries
get_match_zebra GET /match/{match_key}/zebra_motionworks
get_team_event_matches GET /team/{team_key}/event/{event_key}/matches
get_team_event_matches_keys GET /team/{team_key}/event/{event_key}/matches/keys
get_team_event_matches_simple GET /team/{team_key}/event/{event_key}/matches/simple
get_team_matches_by_year GET /team/{team_key}/matches/{year}
get_team_matches_by_year_keys GET /team/{team_key}/matches/{year}/keys
get_team_matches_by_year_simple GET /team/{team_key}/matches/{year}/simple

get_event_match_timeseries

Vec get_event_match_timeseries(event_key, if_none_match)

Gets an array of Match Keys for the given event key that have timeseries data. Returns an empty array if no matches have timeseries data. WARNING: This is not official data, and is subject to a significant possibility of error, or missing data. Do not rely on this data for any purpose. In fact, pretend we made it up. WARNING: This endpoint and corresponding data models are under active development and may change at any time, including in breaking ways.

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_matches

Vecmodels::Match get_event_matches(event_key, if_none_match)

Gets a list of matches for 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::Match

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_matches_keys

Vec get_event_matches_keys(event_key, if_none_match)

Gets a list of match keys for 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_matches_simple

Vecmodels::MatchSimple get_event_matches_simple(event_key, if_none_match)

Gets a short-form list of matches for 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::MatchSimple

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_match

models::Match get_match(match_key, if_none_match)

Gets a Match object for the given match key.

Parameters

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

Return type

models::Match

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_match_simple

models::MatchSimple get_match_simple(match_key, if_none_match)

Gets a short-form Match object for the given match key.

Parameters

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

Return type

models::MatchSimple

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_match_timeseries

Vec<serde_json::Value> get_match_timeseries(match_key, if_none_match)

Gets an array of game-specific Match Timeseries objects for the given match key or an empty array if not available. WARNING: This is not official data, and is subject to a significant possibility of error, or missing data. Do not rely on this data for any purpose. In fact, pretend we made it up. WARNING: This endpoint and corresponding data models are under active development and may change at any time, including in breaking ways.

Parameters

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

Return type

Vec<serde_json::Value>

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_match_zebra

models::Zebra get_match_zebra(match_key, if_none_match)

Gets Zebra MotionWorks data for a Match for the given match key.

Parameters

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

Return type

models::Zebra

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_event_matches

Vecmodels::Match get_team_event_matches(team_key, event_key, if_none_match)

Gets a list of matches for the given team and event.

Parameters

Name Type Description Required Notes
team_key String TBA Team Key, eg frc254 [required]
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::Match

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_event_matches_keys

Vec get_team_event_matches_keys(team_key, event_key, if_none_match)

Gets a list of match keys for matches for the given team and event.

Parameters

Name Type Description Required Notes
team_key String TBA Team Key, eg frc254 [required]
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_team_event_matches_simple

Vecmodels::Match get_team_event_matches_simple(team_key, event_key, if_none_match)

Gets a short-form list of matches for the given team and event.

Parameters

Name Type Description Required Notes
team_key String TBA Team Key, eg frc254 [required]
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::Match

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_matches_by_year

Vecmodels::Match get_team_matches_by_year(team_key, year, if_none_match)

Gets a list of matches for the given team and 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

Vecmodels::Match

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_matches_by_year_keys

Vec get_team_matches_by_year_keys(team_key, year, if_none_match)

Gets a list of match keys for matches for the given team and 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

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_team_matches_by_year_simple

Vecmodels::MatchSimple get_team_matches_by_year_simple(team_key, year, if_none_match)

Gets a short-form list of matches for the given team and 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

Vecmodels::MatchSimple

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]