Client Server API Spec

Resources

These are the 3 main resources:

• Assignments
  • Can have submissions -- BOOL
  • Name -- String(20)
  • Due date? -- DATE
• Submissions
  • Uploaded date? -- DATE
  • Number? -- INT(?)
  • Assignment - Foreign Key
• Users
  • Calnet Email -- String(256)
  • Nickname? -- String(30)
  • Login -- String(20)
  • Role -- INT

Paths

Here are the URL paths I was thinking of

In general, there will be an api, and then a public facing HTML website that will render something nice. We can make the API first, and then make pretty interfaces later.

API

Users

/api/user/ -- CRUD on this

Submissions

/api/assignment/<id>/submission/ -- CRUD on this

To upload a new submission, use this URL: POST /api/assignment/<id>/submission/

Assignments

/api/assignment/ -- CRUD on this