You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 28, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
# The Blue Alliance API Java Library [](https://travis-ci.org/spencerng/TBA-API-Java-Library)
1
+
# The Blue Alliance API Java Library [](https://travis-ci.org/spencerng/blue-alliance-api-java-library)
2
2
3
3
Java client library to retrieve data from The Blue Alliance using TBA API v3
4
4
5
-
Full Javadoc documentation can be found [here](http://spencerng.github.io/TBA-API-Java-Library/)
5
+
Full Javadoc documentation can be found [here](http://spencerng.github.io/blue-alliance-api-java-library/)
6
6
7
7
## Usage
8
8
@@ -15,19 +15,19 @@ Begin by creating a TBA object with your Read TBA API Key. This can be found or
15
15
16
16
The library allows access to almost all of the calls in [The Blue Alliance API v3 documentation](https://www.thebluealliance.com/apidocs/v3).
17
17
18
-
They are grouped into requests with team, event, district, or match parameters, and you will need to use the `teamRequest`, `eventRequest`, or `matchRequest` instance variables found in the [`TBA` class](http://spencerng.github.io/TBA-API-Java-Library/com/thebluealliance/api/v3/TBA.html).
18
+
They are grouped into requests with team, event, district, or match parameters, and you will need to use the `teamRequest`, `eventRequest`, or `matchRequest` instance variables found in the [`TBA` class](http://spencerng.github.io/blue-alliance-api-java-library/com/thebluealliance/api/v3/TBA.html).
19
19
20
20
Here is an example of retrieving an array of teams in the FIRST Mid-Atlantic district in 2017:
A list of request methods for each request object can be found [here](http://spencerng.github.io/TBA-API-Java-Library/com/thebluealliance/api/v3/requests/package-summary.html).
24
+
A list of request methods for each request object can be found [here](http://spencerng.github.io/blue-alliance-api-java-library/com/thebluealliance/api/v3/requests/package-summary.html).
25
25
26
26
### Advance Usage
27
27
28
-
If you want to utilize the `If-Modified-Since` and `Last-Modified` headers, you will need to make a direct URL request with the [`getDataTBA(String urlDirectory)` method](http://spencerng.github.io/TBA-API-Java-Library/com/thebluealliance/api/v3/requests/DataRequest.html#getDataTBA-java.lang.String-java.lang.String-) in the [`DataRequest` class](http://spencerng.github.io/TBA-API-Java-Library/com/thebluealliance/api/v3/requests/DataRequest.html). This will return an [`APIResponse`](http://spencerng.github.io/TBA-API-Java-Library/com/thebluealliance/api/v3/requests/APIResponse.html) object with JSON data, the HTTP response code, and the `Last-Modified` header.
28
+
If you want to utilize the `If-Modified-Since` and `Last-Modified` headers, you will need to make a direct URL request with the [`getDataTBA(String urlDirectory)` method](http://spencerng.github.io/blue-alliance-api-java-library/com/thebluealliance/api/v3/requests/DataRequest.html#getDataTBA-java.lang.String-java.lang.String-) in the [`DataRequest` class](http://spencerng.github.io/blue-alliance-api-java-library/com/thebluealliance/api/v3/requests/DataRequest.html). This will return an [`APIResponse`](http://spencerng.github.io/blue-alliance-api-java-library/com/thebluealliance/api/v3/requests/APIResponse.html) object with JSON data, the HTTP response code, and the `Last-Modified` header.
29
29
30
-
The JSON data will need to be deserialized into an object model with a method in the [`Deserializer` class](http://spencerng.github.io/TBA-API-Java-Library/com/thebluealliance/api/v3/Deserializer.html) before being used.
30
+
The JSON data will need to be deserialized into an object model with a method in the [`Deserializer` class](http://spencerng.github.io/blue-alliance-api-java-library/com/thebluealliance/api/v3/Deserializer.html) before being used.
31
31
32
32
Here is an example of continuously fetching the `Match` objects for the 2017 Mount Olive District Event, if they have been updated. Note that this is very inefficient.
33
33
@@ -46,7 +46,7 @@ Here is an example of continuously fetching the `Match` objects for the 2017 Mou
46
46
47
47
## Models
48
48
49
-
A list of object model classes and their getter methods for instance variables can be found [here](http://spencerng.github.io/TBA-API-Java-Library/com/thebluealliance/api/v3/models/package-summary.html)
49
+
A list of object model classes and their getter methods for instance variables can be found [here](http://spencerng.github.io/blue-alliance-api-java-library/com/thebluealliance/api/v3/models/package-summary.html)
0 commit comments