Skip to content

Latest commit

 

History

History
458 lines (254 loc) · 13.8 KB

DistrictApi.md

File metadata and controls

458 lines (254 loc) · 13.8 KB
Raw

\DistrictApi

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
GetDistrictRankings Get /district/{district_key}/rankings
GetDistrictTeams Get /district/{district_key}/teams
GetDistrictTeamsKeys Get /district/{district_key}/teams/keys
GetDistrictTeamsSimple Get /district/{district_key}/teams/simple
GetDistrictsByYear Get /districts/{year}
GetEventDistrictPoints Get /event/{event_key}/district_points
GetTeamDistricts Get /team/{team_key}/districts

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]

GetDistrictRankings

[]DistrictRanking GetDistrictRankings(ctx, districtKey, optional)

Gets a list of team district rankings for 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 *GetDistrictRankingsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetDistrictRankingsOpts 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

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

GetDistrictTeams

[]Team GetDistrictTeams(ctx, districtKey, optional)

Gets a list of Team objects that competed in 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 *GetDistrictTeamsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetDistrictTeamsOpts 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]

GetDistrictTeamsKeys

[]string GetDistrictTeamsKeys(ctx, districtKey, optional)

Gets a list of Team objects that competed in 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 *GetDistrictTeamsKeysOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetDistrictTeamsKeysOpts 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]

GetDistrictTeamsSimple

[]TeamSimple GetDistrictTeamsSimple(ctx, districtKey, optional)

Gets a short-form list of Team objects that competed in 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 *GetDistrictTeamsSimpleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetDistrictTeamsSimpleOpts 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]

GetDistrictsByYear

[]DistrictList GetDistrictsByYear(ctx, year, optional)

Gets a list of districts and their corresponding district key, for 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 *GetDistrictsByYearOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetDistrictsByYearOpts 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

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

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]

GetTeamDistricts

[]DistrictList GetTeamDistricts(ctx, teamKey, optional)

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.

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 *GetTeamDistrictsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetTeamDistrictsOpts 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

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