Routes Definition

[muddassir-lateef]

All the routes of each schema shall be defined in this issue

Use the approriate formatting for better readability.

• Enclose a class name in ** ** for heading
• add - and a space before each URL to make it a bullet point
• and add > and a space before each description

[muddassir-lateef]

Login

• GET /login/

returns the list of all the logins

• POST /login/add

adds the login in the collection while also creating the respective user and linking it

• DELETE /login/:username

deletes login in the collection but does not delete the respective user linking with it

• PATCH /login/:username

updates the parameters of a login

[Salar24]

Student

• GET /Student/

return all of the students in the database

• POST /Student/add

Add a student to the databse

• GET /Student/:rollNumber

Get student with specific rollNumber

• PATCH /Student/:rollNumber

Update credentials of student rollNumber passed in URl

[ShayanZuberi]

Calendar

• GET calendar/

returns the list of calendars for each year

• GET calendar/:year

returns the list of calendars for a specific year

• POST calendar/addCalendar

creates a new calendar for the year

• PATCH calendar/:year/addEvent

adds the event to the specified calendar
will have an event object in body

[ShayanZuberi]

Exam

• GET exam/

returns the list of all exams

• GET exam/:examID

returns the exam object with requested id

• POST exam/addExam

creates a new exam
exam is passed in request body

• PATCH exam/:examID/editExam

updates the exam record by the requested id
en exam object will be sent in body to completely update

[ShayanZuberi]

Marks

• GET marks/:studentID

returns the list of all marks for the requested Student

• GET marks/:examID

returns the list of all marks for the requested Exam

• POST marks/addMarks

creates new marks object and saves it

• PATCH marks/:marksID

update marks object with the specified ID

[ShayanZuberi]

Lecture

• GET /lecture

returns the list of all lectures

• POST /lecture/addNew

creates a new lecture
lecture object is passed in request body

[Salar24]

Class

• GET /Class/

return all of the classes in the database

• POST /Class/addNew

Add a class to the database
Attributes of the class will be passed in the request body in Json format

[Salar24]

Section

• GET /Section/

return all of the sections in the database

• POST /Section/addNew

Add a section to the database
Attributes will be passed in the request body in Json format