Skip to content

EventApi.md

Latest commit

 

History

History
1601 lines (888 loc) · 47.9 KB

EventApi.md

File metadata and controls

1601 lines (888 loc) · 47.9 KB
Raw

\EventApi

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

Method HTTP request Description
GetDistrictEvents Get /district/{district_key}/events
GetDistrictEventsKeys Get /district/{district_key}/events/keys
GetDistrictEventsSimple Get /district/{district_key}/events/simple
GetEvent Get /event/{event_key}
GetEventAlliances Get /event/{event_key}/alliances
GetEventAwards Get /event/{event_key}/awards
GetEventDistrictPoints Get /event/{event_key}/district_points
GetEventInsights Get /event/{event_key}/insights
GetEventMatchTimeseries Get /event/{event_key}/matches/timeseries
GetEventMatches Get /event/{event_key}/matches
GetEventMatchesKeys Get /event/{event_key}/matches/keys
GetEventMatchesSimple Get /event/{event_key}/matches/simple
GetEventOPRs Get /event/{event_key}/oprs
GetEventPredictions Get /event/{event_key}/predictions
GetEventRankings Get /event/{event_key}/rankings
GetEventSimple Get /event/{event_key}/simple
GetEventTeams Get /event/{event_key}/teams
GetEventTeamsKeys Get /event/{event_key}/teams/keys
GetEventTeamsSimple Get /event/{event_key}/teams/simple
GetEventTeamsStatuses Get /event/{event_key}/teams/statuses
GetEventsByYear Get /events/{year}
GetEventsByYearKeys Get /events/{year}/keys
GetEventsByYearSimple Get /events/{year}/simple
GetTeamEventAwards Get /team/{team_key}/event/{event_key}/awards
GetTeamEventMatches Get /team/{team_key}/event/{event_key}/matches
GetTeamEventMatchesKeys Get /team/{team_key}/event/{event_key}/matches/keys
GetTeamEventMatchesSimple Get /team/{team_key}/event/{event_key}/matches/simple
GetTeamEventStatus Get /team/{team_key}/event/{event_key}/status
GetTeamEvents Get /team/{team_key}/events
GetTeamEventsByYear Get /team/{team_key}/events/{year}
GetTeamEventsByYearKeys Get /team/{team_key}/events/{year}/keys
GetTeamEventsByYearSimple Get /team/{team_key}/events/{year}/simple
GetTeamEventsKeys Get /team/{team_key}/events/keys
GetTeamEventsSimple Get /team/{team_key}/events/simple
GetTeamEventsStatusesByYear Get /team/{team_key}/events/{year}/statuses

GetDistrictEvents

[]Event GetDistrictEvents(ctx, districtKey, optional)

Gets a list of events in the given district.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
districtKey string TBA District Key, eg `2016fim`
optional *GetDistrictEventsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetDistrictEventsOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]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]

GetDistrictEventsKeys

[]string GetDistrictEventsKeys(ctx, districtKey, optional)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
districtKey string TBA District Key, eg `2016fim`
optional *GetDistrictEventsKeysOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetDistrictEventsKeysOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]string

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]

GetDistrictEventsSimple

[]EventSimple GetDistrictEventsSimple(ctx, districtKey, optional)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
districtKey string TBA District Key, eg `2016fim`
optional *GetDistrictEventsSimpleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetDistrictEventsSimpleOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]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]

GetEvent

Event GetEvent(ctx, eventKey, optional)

Gets an Event.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
eventKey string TBA Event Key, eg `2016nytr`
optional *GetEventOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetEventOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

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]

GetEventAlliances

[]EliminationAlliance GetEventAlliances(ctx, eventKey, optional)

Gets a list of Elimination Alliances for the given Event.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
eventKey string TBA Event Key, eg `2016nytr`
optional *GetEventAlliancesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetEventAlliancesOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]EliminationAlliance

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]

GetEventAwards

[]Award GetEventAwards(ctx, eventKey, optional)

Gets a list of awards from the given event.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
eventKey string TBA Event Key, eg `2016nytr`
optional *GetEventAwardsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetEventAwardsOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]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]

GetEventDistrictPoints

EventDistrictPoints GetEventDistrictPoints(ctx, eventKey, optional)

Gets a list of team rankings for the Event.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
eventKey string TBA Event Key, eg `2016nytr`
optional *GetEventDistrictPointsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetEventDistrictPointsOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

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]

GetEventInsights

EventInsights GetEventInsights(ctx, eventKey, optional)

Gets a set of Event-specific insights for the given Event.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
eventKey string TBA Event Key, eg `2016nytr`
optional *GetEventInsightsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetEventInsightsOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

EventInsights

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]

GetEventMatchTimeseries

[]string GetEventMatchTimeseries(ctx, eventKey, optional)

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.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
eventKey string TBA Event Key, eg `2016nytr`
optional *GetEventMatchTimeseriesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetEventMatchTimeseriesOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]string

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]

GetEventMatches

[]Match GetEventMatches(ctx, eventKey, optional)

Gets a list of matches for the given event.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
eventKey string TBA Event Key, eg `2016nytr`
optional *GetEventMatchesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetEventMatchesOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]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]

GetEventMatchesKeys

[]string GetEventMatchesKeys(ctx, eventKey, optional)

Gets a list of match keys for the given event.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
eventKey string TBA Event Key, eg `2016nytr`
optional *GetEventMatchesKeysOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetEventMatchesKeysOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]string

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]

GetEventMatchesSimple

[]MatchSimple GetEventMatchesSimple(ctx, eventKey, optional)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
eventKey string TBA Event Key, eg `2016nytr`
optional *GetEventMatchesSimpleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetEventMatchesSimpleOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]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]

GetEventOPRs

EventOpRs GetEventOPRs(ctx, eventKey, optional)

Gets a set of Event OPRs (including OPR, DPR, and CCWM) for the given Event.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
eventKey string TBA Event Key, eg `2016nytr`
optional *GetEventOPRsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetEventOPRsOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

EventOpRs

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]

GetEventPredictions

map[string]interface{} GetEventPredictions(ctx, eventKey, optional)

Gets information on TBA-generated predictions for the given Event. Contains year-specific information. WARNING This endpoint is currently under development and may change at any time.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
eventKey string TBA Event Key, eg `2016nytr`
optional *GetEventPredictionsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetEventPredictionsOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

map[string]interface{}

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]

GetEventRankings

EventRanking GetEventRankings(ctx, eventKey, optional)

Gets a list of team rankings for the Event.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
eventKey string TBA Event Key, eg `2016nytr`
optional *GetEventRankingsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetEventRankingsOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

EventRanking

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]

GetEventSimple

EventSimple GetEventSimple(ctx, eventKey, optional)

Gets a short-form Event.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
eventKey string TBA Event Key, eg `2016nytr`
optional *GetEventSimpleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetEventSimpleOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

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]

GetEventTeams

[]Team GetEventTeams(ctx, eventKey, optional)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
eventKey string TBA Event Key, eg `2016nytr`
optional *GetEventTeamsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetEventTeamsOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]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]

GetEventTeamsKeys

[]string GetEventTeamsKeys(ctx, eventKey, optional)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
eventKey string TBA Event Key, eg `2016nytr`
optional *GetEventTeamsKeysOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetEventTeamsKeysOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]string

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]

GetEventTeamsSimple

[]TeamSimple GetEventTeamsSimple(ctx, eventKey, optional)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
eventKey string TBA Event Key, eg `2016nytr`
optional *GetEventTeamsSimpleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetEventTeamsSimpleOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]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]

GetEventTeamsStatuses

map[string]TeamEventStatus GetEventTeamsStatuses(ctx, eventKey, optional)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
eventKey string TBA Event Key, eg `2016nytr`
optional *GetEventTeamsStatusesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetEventTeamsStatusesOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

map[string]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]

GetEventsByYear

[]Event GetEventsByYear(ctx, year, optional)

Gets a list of events in the given year.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
year int32 Competition Year (or Season). Must be 4 digits.
optional *GetEventsByYearOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetEventsByYearOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]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]

GetEventsByYearKeys

[]string GetEventsByYearKeys(ctx, year, optional)

Gets a list of event keys in the given year.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
year int32 Competition Year (or Season). Must be 4 digits.
optional *GetEventsByYearKeysOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetEventsByYearKeysOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]string

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]

GetEventsByYearSimple

[]EventSimple GetEventsByYearSimple(ctx, year, optional)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
year int32 Competition Year (or Season). Must be 4 digits.
optional *GetEventsByYearSimpleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetEventsByYearSimpleOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]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]

GetTeamEventAwards

[]Award GetTeamEventAwards(ctx, teamKey, eventKey, optional)

Gets a list of awards the given team won at the given event.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamKey string TBA Team Key, eg `frc254`
eventKey string TBA Event Key, eg `2016nytr`
optional *GetTeamEventAwardsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetTeamEventAwardsOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]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]

GetTeamEventMatches

[]Match GetTeamEventMatches(ctx, teamKey, eventKey, optional)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamKey string TBA Team Key, eg `frc254`
eventKey string TBA Event Key, eg `2016nytr`
optional *GetTeamEventMatchesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetTeamEventMatchesOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]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]

GetTeamEventMatchesKeys

[]string GetTeamEventMatchesKeys(ctx, teamKey, eventKey, optional)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamKey string TBA Team Key, eg `frc254`
eventKey string TBA Event Key, eg `2016nytr`
optional *GetTeamEventMatchesKeysOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetTeamEventMatchesKeysOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]string

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]

GetTeamEventMatchesSimple

[]Match GetTeamEventMatchesSimple(ctx, teamKey, eventKey, optional)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamKey string TBA Team Key, eg `frc254`
eventKey string TBA Event Key, eg `2016nytr`
optional *GetTeamEventMatchesSimpleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetTeamEventMatchesSimpleOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]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]

GetTeamEventStatus

TeamEventStatus GetTeamEventStatus(ctx, teamKey, eventKey, optional)

Gets the competition rank and status of the team at the given event.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamKey string TBA Team Key, eg `frc254`
eventKey string TBA Event Key, eg `2016nytr`
optional *GetTeamEventStatusOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetTeamEventStatusOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

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]

GetTeamEvents

[]Event GetTeamEvents(ctx, teamKey, optional)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamKey string TBA Team Key, eg `frc254`
optional *GetTeamEventsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetTeamEventsOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]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]

GetTeamEventsByYear

[]Event GetTeamEventsByYear(ctx, teamKey, year, optional)

Gets a list of events this team has competed at in the given year.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamKey string TBA Team Key, eg `frc254`
year int32 Competition Year (or Season). Must be 4 digits.
optional *GetTeamEventsByYearOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetTeamEventsByYearOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]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]

GetTeamEventsByYearKeys

[]string GetTeamEventsByYearKeys(ctx, teamKey, year, optional)

Gets a list of the event keys for events this team has competed at in the given year.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamKey string TBA Team Key, eg `frc254`
year int32 Competition Year (or Season). Must be 4 digits.
optional *GetTeamEventsByYearKeysOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetTeamEventsByYearKeysOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]string

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]

GetTeamEventsByYearSimple

[]EventSimple GetTeamEventsByYearSimple(ctx, teamKey, year, optional)

Gets a short-form list of events this team has competed at in the given year.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamKey string TBA Team Key, eg `frc254`
year int32 Competition Year (or Season). Must be 4 digits.
optional *GetTeamEventsByYearSimpleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetTeamEventsByYearSimpleOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]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]

GetTeamEventsKeys

[]string GetTeamEventsKeys(ctx, teamKey, optional)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamKey string TBA Team Key, eg `frc254`
optional *GetTeamEventsKeysOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetTeamEventsKeysOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]string

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]

GetTeamEventsSimple

[]EventSimple GetTeamEventsSimple(ctx, teamKey, optional)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamKey string TBA Team Key, eg `frc254`
optional *GetTeamEventsSimpleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetTeamEventsSimpleOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

[]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]

GetTeamEventsStatusesByYear

map[string]TeamEventStatus GetTeamEventsStatusesByYear(ctx, teamKey, year, optional)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamKey string TBA Team Key, eg `frc254`
year int32 Competition Year (or Season). Must be 4 digits.
optional *GetTeamEventsStatusesByYearOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetTeamEventsStatusesByYearOpts struct

Name Type Description Notes

ifModifiedSince | optional.String| Value of the `Last-Modified` header in the most recently cached response by the client. |

Return type

map[string]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]