Status Report API Documentation

Endpoint 1 - Getting Sprints

Request Format: /api/sprints

Request Type: GET

Returned Data Format: JSON

Description: Gets a list of all sprints in the database for a student.

Example Request: TODO

Example Response:

TODO

Error Handling: TODO

Endpoint 2 - Submitting Team Report

Request Format: /api/submit/team

Request Type: POST

Returned Data Format: TEXT

Description: Submits a team report to the database for a team.

Example Request: TODO

Example Response: TOOD

TODO

Error Handling: TODO

Endpoint 3 - Getting Individual Report

Request Format: /api/individual

Request Type: GET

Returned Data Format: JSON

Description: Gets an individual report from the database. Can return an empty report if no report exists for the student.

Example Request: TODO

Example Response: TOOD

TODO

Error Handling: TODO

Endpoint 4 - Submitting Individual Report

Request Format: /api/submit/individual

Request Type: POST

Returned Data Format: JSON

Description: Submits an individual report to the database for a student.

Example Request: TODO

Example Response: TOOD

TODO

Error Handling: TODO

Endpoint 5 - Getting Team Project Requirements

Request Format: /api/requirements

Request Type: GET

Returned Data Format: JSON

Description: Gets the project requirements of a team from the database.

Example Request: TODO

Example Response: TOOD

TODO

Error Handling: TODO

Endpoint 6 - Submitting Team Project Requirements

Request Format: /api/submit/new_requirement

Request Type: POST

Returned Data Format: JSON

Description: Submits a new team project requirement to the database.

Example Request: TODO

Example Response: TOOD

TODO

Endpoint 7 - Deleting Team Project Requirements

Request Format: /api/submit/delete_requirement

Request Type: POST

Returned Data Format: JSON

Description: Request a requirement to be deleted from the database.

Example Request: TODO

Example Response: TOOD

TODO

Error Handling: TODO

Endpoint 7 - Request Logout

Request Format: /api/logout

Request Type: POST

Returned Data Format: JSON

Description: Request a logout from the server.

Example Request: TODO

Example Response: TOOD

TODO

Error Handling: TODO

Endpoint 8 - Request OAuth Config

Request Format: /api/config

Request Type: GET

Returned Data Format: JSON

Description: Gets the server’s OAuth configuration.

Example Request: TODO

Example Response: TOOD

TODO

Error Handling: TODO

Endpoint 9 - Request Logout

Request Format: /api/logout

Request Type: POST

Returned Data Format: JSON

Description: Request a logout from the server.

Example Request: TODO

Example Response: TOOD

TODO

Endpoint 10 - Request Server Shutdown

Request Format: /api/shutdown

Request Type: POST

Returned Data Format: JSON

Description: Request a server shutdown.

Example Request: TODO

Example Response: TOOD

TODO

Error Handling: TODO

Endpoint 11 - Getting Server Health Status

Request Format: /api/health

Request Type: GET

Returned Data Format: JSON

Description: Request the server health status.

Example Request: TODO

Example Response: TOOD

TODO

Error Handling: TODO

Endpoint 12 - Getting User Type

Request Format: /api/user

Request Type: GET

Returned Data Format: JSON

Description: Returns the user type of the current user.

Example Request: TODO

Example Response:

TODO

Error Handling: TODO

Endpoint 13 - Submitting Class Update

Request Format: /api/admin/classes

Request Type: POST

Returned Data Format: JSON

Description: Submits a file containing a list of classes to the database.

Example Request: TODO

Example Response: TOOD

TODO

Error Handling: TODO

Endpoint 14 - Submitting Students Update

Request Format: /api/admin/students

Request Type: POST

Returned Data Format: JSON

Description: Submits a file containig a list of students within a class to the database.

Example Request: TODO

Example Response: TOOD

TODO

Error Handling: TODO

Endpoint 15 - Submitting Teams Update

Request Format: /api/admin/teams

Request Type: POST

Returned Data Format: JSON

Description: Submits a file containig a list of teams within a class to the database.

Example Request: TODO

Example Response: TOOD

TODO

Error Handling: TODO

Endpoint 16 - Downloading Class Sprint Submissions

Request Format: /api/admin/sprints

Request Type: GET

Returned Data Format: JSON

Description: Downloads a file of all sprint submissions for a class.

Example Request: TODO

Example Response: TOOD

TODO