route-documentation.md

APP Routes

• API

  • api/users/ - GET

    Get status of API.

• Users

  • api/users/ - GET

    Get information for a user.

  • Students

    • api/users/students/all - GET

      Get all students that match an inputted filters.

    • api/users/students/ - GET

      Get information for a student.

    • api/users/students/ - PUT

      Add a new student.

    • api/users/students/ - POST

      Update a student.

    • api/users/students/ - DELETE

      Delete a student.

• Works

  • api/works/all - GET

    Get all works that match an inputted filters.

  • api/works - GET

    Get information for a work.

  • api/works - PUT

    Add a new work.

  • api/works - POST

    Update a work.

  • api/works - DELETE

    Update a work.

  • Feedbacks

    • /api/works/feedbacks - GET

      Get information for a feedback.

    • /api/works/feedbacks - PUT

      Add a new feedback.

    • /api/works/feedbacks - POST

      Update a feedback.

  • Annotations

    • /api/works/annotations/all - GET

      Get annotation information for all annotations of a submission.

    • /api/works/annotations - GET

      Get annotation information for all annotations of a submission written by a specific user.

    • /api/works/annotations - PUT

      Add an annotation.

    • /api/works/annotations - DELETE

      Delete an annotation.

  • Submissions

    • /api/works/submissions - GET

      Get information about a submission.

    • /api/works/submissions - POST

      Update a submission.

    • /api/works/submissions/files - GET

      Get a file from a submission.

    • /api/works/submissions/files - PUT

      Add a file to a submission.

    • /api/works/submissions/files - DELETE

      Get a file from a submission.

    • /api/works/submissions/files/upload - POST

      Upload a submission.