Code Monkey home page Code Monkey logo

blue-api-v3's Introduction

swagger-java-client

The Blue Alliance API v3

  • API version: 3.8.0
    • Build date: 2020-03-01T17:18:29.994708-05:00[US/Eastern]

Overview Information and statistics about FIRST Robotics Competition teams and events. # Authentication All endpoints require an Auth Key to be passed in the header X-TBA-Auth-Key. If you do not have an auth key yet, you can obtain one from your Account Page. A User-Agent header may need to be set to prevent a 403 Unauthorized error.

Automatically generated by the Swagger Codegen

Requirements

Building the API client library requires:

  1. Java 1.7+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>io.swagger</groupId>
  <artifactId>swagger-java-client</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.swagger:swagger-java-client:1.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/swagger-java-client-1.0.0.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DistrictApi;

import java.io.File;
import java.util.*;

public class DistrictApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        DistrictApi apiInstance = new DistrictApi();
        String districtKey = "districtKey_example"; // String | TBA District Key, eg `2016fim`
        String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
        try {
            List<Event> result = apiInstance.getDistrictEvents(districtKey, ifModifiedSince);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistrictApi#getDistrictEvents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DistrictApi;

import java.io.File;
import java.util.*;

public class DistrictApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        DistrictApi apiInstance = new DistrictApi();
        String districtKey = "districtKey_example"; // String | TBA District Key, eg `2016fim`
        String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
        try {
            List<String> result = apiInstance.getDistrictEventsKeys(districtKey, ifModifiedSince);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistrictApi#getDistrictEventsKeys");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DistrictApi;

import java.io.File;
import java.util.*;

public class DistrictApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        DistrictApi apiInstance = new DistrictApi();
        String districtKey = "districtKey_example"; // String | TBA District Key, eg `2016fim`
        String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
        try {
            List<EventSimple> result = apiInstance.getDistrictEventsSimple(districtKey, ifModifiedSince);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistrictApi#getDistrictEventsSimple");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DistrictApi;

import java.io.File;
import java.util.*;

public class DistrictApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        DistrictApi apiInstance = new DistrictApi();
        String districtKey = "districtKey_example"; // String | TBA District Key, eg `2016fim`
        String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
        try {
            List<DistrictRanking> result = apiInstance.getDistrictRankings(districtKey, ifModifiedSince);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistrictApi#getDistrictRankings");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DistrictApi;

import java.io.File;
import java.util.*;

public class DistrictApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        DistrictApi apiInstance = new DistrictApi();
        String districtKey = "districtKey_example"; // String | TBA District Key, eg `2016fim`
        String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
        try {
            List<Team> result = apiInstance.getDistrictTeams(districtKey, ifModifiedSince);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistrictApi#getDistrictTeams");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DistrictApi;

import java.io.File;
import java.util.*;

public class DistrictApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        DistrictApi apiInstance = new DistrictApi();
        String districtKey = "districtKey_example"; // String | TBA District Key, eg `2016fim`
        String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
        try {
            List<String> result = apiInstance.getDistrictTeamsKeys(districtKey, ifModifiedSince);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistrictApi#getDistrictTeamsKeys");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DistrictApi;

import java.io.File;
import java.util.*;

public class DistrictApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        DistrictApi apiInstance = new DistrictApi();
        String districtKey = "districtKey_example"; // String | TBA District Key, eg `2016fim`
        String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
        try {
            List<TeamSimple> result = apiInstance.getDistrictTeamsSimple(districtKey, ifModifiedSince);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistrictApi#getDistrictTeamsSimple");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DistrictApi;

import java.io.File;
import java.util.*;

public class DistrictApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        DistrictApi apiInstance = new DistrictApi();
        Integer year = 56; // Integer | Competition Year (or Season). Must be 4 digits.
        String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
        try {
            List<DistrictList> result = apiInstance.getDistrictsByYear(year, ifModifiedSince);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistrictApi#getDistrictsByYear");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DistrictApi;

import java.io.File;
import java.util.*;

public class DistrictApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        DistrictApi apiInstance = new DistrictApi();
        String eventKey = "eventKey_example"; // String | TBA Event Key, eg `2016nytr`
        String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
        try {
            EventDistrictPoints result = apiInstance.getEventDistrictPoints(eventKey, ifModifiedSince);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistrictApi#getEventDistrictPoints");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DistrictApi;

import java.io.File;
import java.util.*;

public class DistrictApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        DistrictApi apiInstance = new DistrictApi();
        String teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
        String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
        try {
            List<DistrictList> result = apiInstance.getTeamDistricts(teamKey, ifModifiedSince);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistrictApi#getTeamDistricts");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
DistrictApi getDistrictEvents GET /district/{district_key}/events
DistrictApi getDistrictEventsKeys GET /district/{district_key}/events/keys
DistrictApi getDistrictEventsSimple GET /district/{district_key}/events/simple
DistrictApi getDistrictRankings GET /district/{district_key}/rankings
DistrictApi getDistrictTeams GET /district/{district_key}/teams
DistrictApi getDistrictTeamsKeys GET /district/{district_key}/teams/keys
DistrictApi getDistrictTeamsSimple GET /district/{district_key}/teams/simple
DistrictApi getDistrictsByYear GET /districts/{year}
DistrictApi getEventDistrictPoints GET /event/{event_key}/district_points
DistrictApi getTeamDistricts GET /team/{team_key}/districts
EventApi getDistrictEvents GET /district/{district_key}/events
EventApi getDistrictEventsKeys GET /district/{district_key}/events/keys
EventApi getDistrictEventsSimple GET /district/{district_key}/events/simple
EventApi getEvent GET /event/{event_key}
EventApi getEventAlliances GET /event/{event_key}/alliances
EventApi getEventAwards GET /event/{event_key}/awards
EventApi getEventDistrictPoints GET /event/{event_key}/district_points
EventApi getEventInsights GET /event/{event_key}/insights
EventApi getEventMatchTimeseries GET /event/{event_key}/matches/timeseries
EventApi getEventMatches GET /event/{event_key}/matches
EventApi getEventMatchesKeys GET /event/{event_key}/matches/keys
EventApi getEventMatchesSimple GET /event/{event_key}/matches/simple
EventApi getEventOPRs GET /event/{event_key}/oprs
EventApi getEventPredictions GET /event/{event_key}/predictions
EventApi getEventRankings GET /event/{event_key}/rankings
EventApi getEventSimple GET /event/{event_key}/simple
EventApi getEventTeams GET /event/{event_key}/teams
EventApi getEventTeamsKeys GET /event/{event_key}/teams/keys
EventApi getEventTeamsSimple GET /event/{event_key}/teams/simple
EventApi getEventTeamsStatuses GET /event/{event_key}/teams/statuses
EventApi getEventsByYear GET /events/{year}
EventApi getEventsByYearKeys GET /events/{year}/keys
EventApi getEventsByYearSimple GET /events/{year}/simple
EventApi getTeamEventAwards GET /team/{team_key}/event/{event_key}/awards
EventApi getTeamEventMatches GET /team/{team_key}/event/{event_key}/matches
EventApi getTeamEventMatchesKeys GET /team/{team_key}/event/{event_key}/matches/keys
EventApi getTeamEventMatchesSimple GET /team/{team_key}/event/{event_key}/matches/simple
EventApi getTeamEventStatus GET /team/{team_key}/event/{event_key}/status
EventApi getTeamEvents GET /team/{team_key}/events
EventApi getTeamEventsByYear GET /team/{team_key}/events/{year}
EventApi getTeamEventsByYearKeys GET /team/{team_key}/events/{year}/keys
EventApi getTeamEventsByYearSimple GET /team/{team_key}/events/{year}/simple
EventApi getTeamEventsKeys GET /team/{team_key}/events/keys
EventApi getTeamEventsSimple GET /team/{team_key}/events/simple
EventApi getTeamEventsStatusesByYear GET /team/{team_key}/events/{year}/statuses
ListApi getDistrictEvents GET /district/{district_key}/events
ListApi getDistrictEventsKeys GET /district/{district_key}/events/keys
ListApi getDistrictEventsSimple GET /district/{district_key}/events/simple
ListApi getDistrictRankings GET /district/{district_key}/rankings
ListApi getDistrictTeams GET /district/{district_key}/teams
ListApi getDistrictTeamsKeys GET /district/{district_key}/teams/keys
ListApi getDistrictTeamsSimple GET /district/{district_key}/teams/simple
ListApi getEventTeams GET /event/{event_key}/teams
ListApi getEventTeamsKeys GET /event/{event_key}/teams/keys
ListApi getEventTeamsSimple GET /event/{event_key}/teams/simple
ListApi getEventTeamsStatuses GET /event/{event_key}/teams/statuses
ListApi getEventsByYear GET /events/{year}
ListApi getEventsByYearKeys GET /events/{year}/keys
ListApi getEventsByYearSimple GET /events/{year}/simple
ListApi getTeamEventsStatusesByYear GET /team/{team_key}/events/{year}/statuses
ListApi getTeams GET /teams/{page_num}
ListApi getTeamsByYear GET /teams/{year}/{page_num}
ListApi getTeamsByYearKeys GET /teams/{year}/{page_num}/keys
ListApi getTeamsByYearSimple GET /teams/{year}/{page_num}/simple
ListApi getTeamsKeys GET /teams/{page_num}/keys
ListApi getTeamsSimple GET /teams/{page_num}/simple
MatchApi getEventMatchTimeseries GET /event/{event_key}/matches/timeseries
MatchApi getEventMatches GET /event/{event_key}/matches
MatchApi getEventMatchesKeys GET /event/{event_key}/matches/keys
MatchApi getEventMatchesSimple GET /event/{event_key}/matches/simple
MatchApi getMatch GET /match/{match_key}
MatchApi getMatchSimple GET /match/{match_key}/simple
MatchApi getMatchTimeseries GET /match/{match_key}/timeseries
MatchApi getMatchZebra GET /match/{match_key}/zebra_motionworks
MatchApi getTeamEventMatches GET /team/{team_key}/event/{event_key}/matches
MatchApi getTeamEventMatchesKeys GET /team/{team_key}/event/{event_key}/matches/keys
MatchApi getTeamEventMatchesSimple GET /team/{team_key}/event/{event_key}/matches/simple
MatchApi getTeamMatchesByYear GET /team/{team_key}/matches/{year}
MatchApi getTeamMatchesByYearKeys GET /team/{team_key}/matches/{year}/keys
MatchApi getTeamMatchesByYearSimple GET /team/{team_key}/matches/{year}/simple
TbaApi getStatus GET /status
TeamApi getDistrictRankings GET /district/{district_key}/rankings
TeamApi getDistrictTeams GET /district/{district_key}/teams
TeamApi getDistrictTeamsKeys GET /district/{district_key}/teams/keys
TeamApi getDistrictTeamsSimple GET /district/{district_key}/teams/simple
TeamApi getEventTeams GET /event/{event_key}/teams
TeamApi getEventTeamsKeys GET /event/{event_key}/teams/keys
TeamApi getEventTeamsSimple GET /event/{event_key}/teams/simple
TeamApi getEventTeamsStatuses GET /event/{event_key}/teams/statuses
TeamApi getTeam GET /team/{team_key}
TeamApi getTeamAwards GET /team/{team_key}/awards
TeamApi getTeamAwardsByYear GET /team/{team_key}/awards/{year}
TeamApi getTeamDistricts GET /team/{team_key}/districts
TeamApi getTeamEventAwards GET /team/{team_key}/event/{event_key}/awards
TeamApi getTeamEventMatches GET /team/{team_key}/event/{event_key}/matches
TeamApi getTeamEventMatchesKeys GET /team/{team_key}/event/{event_key}/matches/keys
TeamApi getTeamEventMatchesSimple GET /team/{team_key}/event/{event_key}/matches/simple
TeamApi getTeamEventStatus GET /team/{team_key}/event/{event_key}/status
TeamApi getTeamEvents GET /team/{team_key}/events
TeamApi getTeamEventsByYear GET /team/{team_key}/events/{year}
TeamApi getTeamEventsByYearKeys GET /team/{team_key}/events/{year}/keys
TeamApi getTeamEventsByYearSimple GET /team/{team_key}/events/{year}/simple
TeamApi getTeamEventsKeys GET /team/{team_key}/events/keys
TeamApi getTeamEventsSimple GET /team/{team_key}/events/simple
TeamApi getTeamEventsStatusesByYear GET /team/{team_key}/events/{year}/statuses
TeamApi getTeamMatchesByYear GET /team/{team_key}/matches/{year}
TeamApi getTeamMatchesByYearKeys GET /team/{team_key}/matches/{year}/keys
TeamApi getTeamMatchesByYearSimple GET /team/{team_key}/matches/{year}/simple
TeamApi getTeamMediaByTag GET /team/{team_key}/media/tag/{media_tag}
TeamApi getTeamMediaByTagYear GET /team/{team_key}/media/tag/{media_tag}/{year}
TeamApi getTeamMediaByYear GET /team/{team_key}/media/{year}
TeamApi getTeamRobots GET /team/{team_key}/robots
TeamApi getTeamSimple GET /team/{team_key}/simple
TeamApi getTeamSocialMedia GET /team/{team_key}/social_media
TeamApi getTeamYearsParticipated GET /team/{team_key}/years_participated
TeamApi getTeams GET /teams/{page_num}
TeamApi getTeamsByYear GET /teams/{year}/{page_num}
TeamApi getTeamsByYearKeys GET /teams/{year}/{page_num}/keys
TeamApi getTeamsByYearSimple GET /teams/{year}/{page_num}/simple
TeamApi getTeamsKeys GET /teams/{page_num}/keys
TeamApi getTeamsSimple GET /teams/{page_num}/simple

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

apiKey

  • Type: API key
  • API key parameter name: X-TBA-Auth-Key
  • Location: HTTP header

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

blue-api-v3's People

Contributors

dc74089 avatar

Watchers

James Cloos avatar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.