Skip to content

Latest commit

 

History

History
64 lines (44 loc) · 1.83 KB

TBAApi.md

File metadata and controls

64 lines (44 loc) · 1.83 KB
Raw

TBAApi

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

Method HTTP request Description
getStatus GET /status

getStatus

APIStatus getStatus(ifModifiedSince)

Returns API status, and TBA status information.

Example

// Import classes:
//import net.thefletcher.tbaapi.v3client.ApiClient;
//import net.thefletcher.tbaapi.v3client.ApiException;
//import net.thefletcher.tbaapi.v3client.Configuration;
//import net.thefletcher.tbaapi.v3client.auth.*;
//import net.thefletcher.tbaapi.v3client.api.TBAApi;

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");

TBAApi apiInstance = new TBAApi();
String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
    APIStatus result = apiInstance.getStatus(ifModifiedSince);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TBAApi#getStatus");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
ifModifiedSince String Value of the `Last-Modified` header in the most recently cached response by the client. [optional]

Return type

APIStatus

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json