-
Notifications
You must be signed in to change notification settings - Fork 1
Backend API
The StrangeScout scouting system includes a fully featured REST API to interact with the database.
/api/events
A GET request will return a JSON formatted array of all available events.
/api/teams
A GET request will return a JSON formatted array of all available teams.
/api/event/<event>/teams
A GET request will return a JSON formatted array of all available teams from a specified event.
/api/event/<event>/matches
A GET request will return a JSON formatted array of all available matches from a specified event.
/api/event/<event>/match/<match>/teams
A GET request will return a JSON formatted array of all available teams from a specified match at a specified event.
/api/event/<event>/team/<team>/matches
A GET request will return a JSON formatted array of all available matches of a specified team at a specified event.
/api/team/<team>/events
A GET request will return a JSON formatted array of all available events of a specified team.
A Note on Formats: All of the following queries return a CSV file by default. This is useful for importing into spreadsheet software and allows for better viewing on mobile devices, but is not optimal for parsing in a program. Data can be returned in a JSON formatted string by setting the Accept header to application/json.
/api/dump
A GET request will return a CSV file of all records.
/api/event/<event>
A GET request will return a CSV file of all records from the specified event.
/api/team/<team>
A GET request will return a CSV file of all records of the specified team.
/api/event/<event>/match/<match>
A GET request will return a CSV file of all records of the specified match from the specified event.
/api/event/<event>/team/<team>
A GET request will return a CSV file of all records of the specified team from the specified event.
/api/event/<event>/team/<team>/match/<match> or /api/event/<event>/match/<match>/team/<team>
A GET request will return a CSV file of a single team from the specified match from the specified event.
Thanks for using the StrangeScout system! Remember that under the GNU AGPL license of this project, users are required to make source code available to modified versions they host on the net, so make sure you're forks are set to public and you're good to go! Of course, contributions to upstream are always welcome!
StrangeScout is brought to you by the members of FRC Team #1533 at ECG Robotics, Inc, a 501(c)(3) nonprofit organization. Consider donating to us if this software helps your team succeed!