Skip to content

RESTful

marw12 edited this page Nov 28, 2019 · 25 revisions

Parameters Description

Person

Parameters Description
firstName The first name of the person
lastName The last name of the person
userName The user name of the person

Course

Parameters Description
name The name of the course
description The description of the course

School

Parameters Description
name The name of the school
schoolType The type of the school

Subject

Parameters Description
name The name of the subject
school The school associated with the subject
description The description of the subject

Evaluation

Parameters Description
comment The actual content of the evaluation
rating the rating of the tutor
ID the ID of the evaluation

Student

Parameters Description
password The password created by the student
person The actual person (object)
studentId The ID of the student

Tutor

Parameters Description
password The password created by the tutor
person The actual person (object)
tutorId The ID of the tutor

Room

Parameters Description
name The name of the room
isAvailable Is the room available

Session

Parameters Description
date The date of the session
startTime The start time of the session
endTime The end time of the session

Course

POST request

Create a course: https://tutoringapp-15.herokuapp.com/createCourse/?courseName=ECSE321&description=niceee

GET request

Get all courses: https://tutoringapp-15.herokuapp.com/allCourses/

School

POST request

Create a school: https://tutoringapp-15.herokuapp.com/addSchool/?schoolName=McGill&schoolType=University

GET request

Get all schools: https://tutoringapp-15.herokuapp.com/allSchools/

Subject

POST request

Create a subject: https://tutoringapp-15.herokuapp.com/createSubject/?subjectName=Math&schoolName=McGill&subjectDescription=university_level

GET request

Get all subjects: https://tutoringapp-15.herokuapp.com/getAllSubjects/

Evaluation

POST request

Create an evaluation: https://tutoringapp-15.herokuapp.com/createEvaluation/?comment=Good&rating=4&type=tutorEval&studentId=0&managerId=0

Flag an evaluation: https://tutoringapp-15.herokuapp.com/flagEvaluation/?evaluationID=0

Delete an evaluation: https://tutoringapp-15.herokuapp.com/deleteEvaluation/?ID=0

GET request

Get list of Evaluation: https://tutoringapp-15.herokuapp.com/allEvaluations/

Student

POST request

Create a new student: https://tutoringapp-15.herokuapp.com/createStudent/?password=123&userName=Mich

Deleting a student: https://tutoringapp-15.herokuapp.com/deleteStudent/?studentId=124

GET request

Get one student: https://tutoringapp-15.herokuapp.com/student/?studentId=0

Get removed students : https://tutoringapp-15.herokuapp.com/removedStudents/

Get all students: https://tutoringapp-15.herokuapp.com/allStudents/

Tutor

Create a new tutor: https://tutoringapp-15.herokuapp.com/createTutor/?&hourlyRate=18.75&password=12345&userName=mriendeau

Approve a tutor: https://tutoringapp-15.herokuapp.com/approveTutor/?tutorID=0

Delete a tutor : https://tutoringapp-15.herokuapp.com/deleteTutor/?tutorId=143

GET request

Get one tutor: https://tutoringapp-15.herokuapp.com/tutor/?tutorId=0

Get removed tutors: https://tutoringapp-15.herokuapp.com/removedTutors/

Get all tutors: https://tutoringapp-15.herokuapp.com/allTutors/

Room

POST Request

Create a new room : https://tutoringapp-15.herokuapp.com/createRoom/?roomName=coolRoom&roomType=largeRoom

GET Requests

Get all rooms: https://tutoringapp-15.herokuapp.com/getAllRooms/ Get available large rooms: https://tutoringapp-15.herokuapp.com/getAvailableLargeRooms/?date=2020-05-23&startTime=09:00&endTime=10:30

Session

POST Requests

Create a new session: https://tutoringapp-15.herokuapp.com/createSession/?date=2020-05-23&startTime=09:00&endTime=10:30&type=groupSession&course=ECSE321&managerId=0

Assign a tutor to a group session: https://tutoringapp-15.herokuapp.com/assignTutor/?tutorId=0&sessionId=0

GET Requests

Get all sessions for a day: https://tutoringapp-15.herokuapp.com/getSessionsForADay/?date=2020-05-23

Get all sessions: https://tutoringapp-15.herokuapp.com/getAllSessions/

Person

GET Requests

Create a person: https://tutoringapp-15.herokuapp.com/createPerson/?firstName=Maxime&lastName=Buteau&userName=mbuteau

GET Requests

Get all persons: https://tutoringapp-15.herokuapp.com/getAllPersons/

Get person by first name last name: https://tutoringapp-15.herokuapp.com/getPersonByFirstLast/?firstName=John&lastName=Doe

Get person by user name: https://tutoringapp-15.herokuapp.com/getPersonByUserName/?userName=jdoe

Manager

POST Requests

Create a manager: https://tutoringapp-15.herokuapp.com/createManager/?password=123&userName=maxbuteau

GET Requests

Get all managers: https://tutoringapp-15.herokuapp.com/getAllManagers/