Skip to content

Documentation of REST methods

Salman78 edited this page Mar 5, 2019 · 4 revisions

Below is a documented list of REST Methods that we developed and it is separated by functionalities related to respective application Views. Except for the PUT report submission methods (submitinitialReport(@RequestParam, @PathVariable..) etc) Coop-Admin view also has access to other REST APIs listed under Student.

REST APIs for Student(Our) View:

Methods Request Address Request Type
createStudent() https://cryptic-coast-32220.herokuapp.com/students POST
createCoop() https://cryptic-coast-32220.herokuapp.com/coops POST
getStudent() https://cryptic-coast-32220.herokuapp.com/students/{studentMcgillID} GET
getCoop() https://cryptic-coast-32220.herokuapp.com/students/{studentMcgillID}/{coopID} GET
submitInitialReport() https://cryptic-coast.32220.herokuapp.com/students/{studentMcgillID}/{coopID}/initialReport PUT
submitTechnicalReport() https://cryptic-coast-32220.herokuapp.com/students/{studentMcgillID}/{coopID}/technicalReport PUT
submitEvaluationReport() https://cryptic-coast-32220.herokuapp.com/students/{studentMcgillID}/{coopID}/evaluationReport PUT
getProgress() https://cryptic-coast-32220.herokuapp.com/students/{studentMcgillID}/progress GET

REST APIs for Coop-Admin View:

Methods Request Address Request Type
getAllStudents() https://cryptic-coast-32220.herokuapp.com/students GET
getAllCoops() https://cryptic-coast-32220.herokuapp.com/coops GET
editStudentEnrolment() https://cryptic-coast-32220.herokuapp.com/students/{studentMcgillID}/editEnrolment PUT
editStudentWorkPermit() https://cryptic-coast-32220.herokuapp.com/coops/{coopID}/editWorkPermit PUT
editCoopCourses() https://cryptic-coast-32220.herokuapp.com/coops/{coopID}/editCoopCourses PUT
editCoopSemester() https://cryptic-coast-32220.herokuapp.com/coops/{coopID}/editCoopSemester PUT
editDates() https://cryptic-coast-32220.herokuapp.com/coops/{coopID}/editDates PUT
deleteStudent() https://cryptic-coast-32220.herokuapp.com/students DELETE
deleteCoop() https://cryptic-coast-32220.herokuapp.com/coops DELETE

REST APIs for Employer View:

Methods Request Address Request Type
getStudent() https://cryptic-coast-32220.herokuapp.com/students/{studentMcgillID} GET
getCoop() https://cryptic-coast-32220.herokuapp.com/students/{studentMcgillID}/{coopID} GET