API Reference¶

Base URL: _add once deployed_

This page should stay in sync with the actual API — update it whenever an endpoint changes. The rubric marks "API available externally with documentation" at the advanced tier, so treat this as a living contract, not a one-off writeup.

Authentication¶

Describe how clients authenticate (e.g. bearer token from your auth provider).

Authorization: Bearer <token>

Endpoints¶

Courses¶

Method	Path	Description
`GET`	`/api/courses`	List courses
`GET`	`/api/courses/{id}`	Get a course

Tutors¶

Method	Path	Description
`GET`	`/api/tutors`	List tutors
`GET`	`/api/tutors/{id}`	Get a tutor profile

Assignments¶

Method	Path	Description
`GET`	`/api/assignments`	List assignments
`POST`	`/api/assignments`	Create an assignment
`DELETE`	`/api/assignments/{id}`	Remove an assignment

Timesheets¶

Method	Path	Description
`GET`	`/api/timesheets`	List timesheets
`POST`	`/api/timesheets`	Submit a timesheet
`PATCH`	`/api/timesheets/{id}`	Approve / reject / correct

Overflow work¶

Method	Path	Description
`GET`	`/api/overflow`	List unclaimed overflow work
`POST`	`/api/overflow/{id}/volunteer`	Volunteer for a post

Example request/response¶

GET /api/courses/123

{
  "id": "123",
  "name": "COMS3011A",
  "requiredMarkPercent": 70
}

Error format¶

Document your standard error envelope once decided, e.g.:

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "..."
  }
}