Skip to content

Latest commit

 

History

History
1308 lines (704 loc) · 41.5 KB

TeamApi.md

File metadata and controls

1308 lines (704 loc) · 41.5 KB
Raw

\TeamApi

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

Method HTTP request Description
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_team GET /team/{team_key}
get_team_awards GET /team/{team_key}/awards
get_team_awards_by_year GET /team/{team_key}/awards/{year}
get_team_districts GET /team/{team_key}/districts
get_team_event_awards GET /team/{team_key}/event/{event_key}/awards
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_event_status GET /team/{team_key}/event/{event_key}/status
get_team_events GET /team/{team_key}/events
get_team_events_by_year GET /team/{team_key}/events/{year}
get_team_events_by_year_keys GET /team/{team_key}/events/{year}/keys
get_team_events_by_year_simple GET /team/{team_key}/events/{year}/simple
get_team_events_keys GET /team/{team_key}/events/keys
get_team_events_simple GET /team/{team_key}/events/simple
get_team_events_statuses_by_year GET /team/{team_key}/events/{year}/statuses
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_team_media_by_tag GET /team/{team_key}/media/tag/{media_tag}
get_team_media_by_tag_year GET /team/{team_key}/media/tag/{media_tag}/{year}
get_team_media_by_year GET /team/{team_key}/media/{year}
get_team_robots GET /team/{team_key}/robots
get_team_simple GET /team/{team_key}/simple
get_team_social_media GET /team/{team_key}/social_media
get_team_years_participated GET /team/{team_key}/years_participated
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_rankings

Veccrate::models::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

Veccrate::models::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

Veccrate::models::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

Veccrate::models::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

Veccrate::models::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

Veccrate::models::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

Veccrate::models::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

Veccrate::models::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

Veccrate::models::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

Veccrate::models::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, crate::models::TeamEventStatus> 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, crate::models::TeamEventStatus>

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

crate::models::Team get_team(team_key, if_none_match)

Gets a Team object for the team referenced by the given key.

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

crate::models::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_team_awards

Veccrate::models::Award get_team_awards(team_key, if_none_match)

Gets a list of awards the given team has won.

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

Veccrate::models::Award

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_awards_by_year

Veccrate::models::Award get_team_awards_by_year(team_key, year, if_none_match)

Gets a list of awards the given team has won in a 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

Veccrate::models::Award

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

Veccrate::models::DistrictList get_team_districts(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

Veccrate::models::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_team_event_awards

Veccrate::models::Award get_team_event_awards(team_key, event_key, if_none_match)

Gets a list of awards the given team won at the given 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

Veccrate::models::Award

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

Veccrate::models::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

Veccrate::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_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

Veccrate::models::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

Veccrate::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_team_event_status

crate::models::TeamEventStatus get_team_event_status(team_key, event_key, if_none_match)

Gets the competition rank and status of the team at the given 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

crate::models::TeamEventStatus

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

Veccrate::models::Event get_team_events(team_key, if_none_match)

Gets a list of all events this team has competed at.

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

Veccrate::models::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_team_events_by_year

Veccrate::models::Event get_team_events_by_year(team_key, year, if_none_match)

Gets a list of 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

Veccrate::models::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_team_events_by_year_keys

Vec get_team_events_by_year_keys(team_key, year, if_none_match)

Gets a list of the event keys 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

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_events_by_year_simple

Veccrate::models::EventSimple get_team_events_by_year_simple(team_key, year, if_none_match)

Gets a short-form list of 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

Veccrate::models::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_team_events_keys

Vec get_team_events_keys(team_key, if_none_match)

Gets a list of the event keys for all events this team has competed at.

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

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_events_simple

Veccrate::models::EventSimple get_team_events_simple(team_key, if_none_match)

Gets a short-form list of all events this team has competed at.

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

Veccrate::models::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_team_events_statuses_by_year

::std::collections::HashMap<String, crate::models::TeamEventStatus> 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, crate::models::TeamEventStatus>

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

Veccrate::models::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

Veccrate::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_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

Veccrate::models::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

Veccrate::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_team_media_by_tag

Veccrate::models::Media get_team_media_by_tag(team_key, media_tag, if_none_match)

Gets a list of Media (videos / pictures) for the given team and tag.

Parameters

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

Return type

Veccrate::models::Media

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_media_by_tag_year

Veccrate::models::Media get_team_media_by_tag_year(team_key, media_tag, year, if_none_match)

Gets a list of Media (videos / pictures) for the given team, tag and year.

Parameters

Name Type Description Required Notes
team_key String TBA Team Key, eg frc254 [required]
media_tag String Media Tag which describes the Media. [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

Veccrate::models::Media

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_media_by_year

Veccrate::models::Media get_team_media_by_year(team_key, year, if_none_match)

Gets a list of Media (videos / pictures) 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

Veccrate::models::Media

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_robots

Veccrate::models::TeamRobot get_team_robots(team_key, if_none_match)

Gets a list of year and robot name pairs for each year that a robot name was provided. Will return an empty array if the team has never named a robot.

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

Veccrate::models::TeamRobot

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_simple

crate::models::TeamSimple get_team_simple(team_key, if_none_match)

Gets a Team_Simple object for the team referenced by the given key.

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

crate::models::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_team_social_media

Veccrate::models::Media get_team_social_media(team_key, if_none_match)

Gets a list of Media (social media) for the given team.

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

Veccrate::models::Media

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_years_participated

Vec get_team_years_participated(team_key, if_none_match)

Gets a list of years in which the team participated in at least one competition.

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

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

Veccrate::models::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

Veccrate::models::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

Veccrate::models::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

Veccrate::models::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

Veccrate::models::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

Veccrate::models::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

Veccrate::models::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

Veccrate::models::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]