-
Notifications
You must be signed in to change notification settings - Fork 2
RESTful services API
This is how to use our RESTful services:
Create: "/create[name of the class]" Viewing: "/all[name of the class in plural]"
| Parameters | Description |
|---|---|
| coopId | ID of the coop position to set |
| startDate | Starting date of the coop position, formatted MM/dd/yyyy |
| endDate | Ending date of the coop position, formatted MM/dd/yyyy |
| description | Description of the coop position |
| location | Location of the coop position |
| term | School term of the coop position |
| status | Wanted status of the coop position public enum Status { PENDING, REJECTED, COMPLETED, FAILED, ACCEPTED } |
| Parameters | Description |
|---|---|
| studentId | The ID of the student taking the coop position |
| firstName | Student's first name |
| lastName | Student's last name |
| Parameters | Description |
|---|---|
| Email of the term instructor |
| Parameters | Description |
|---|---|
| courseName | The name of the course |
Ex: http://cooperator-backend-260.herokuapp.com/createCoop?startDate=05/06/2018&endDate=08/16/2018&description=softwareintern&location=montreal&term=summer 2018&studentId=13
Ex: http://cooperator-backend-260.herokuapp.com/setCoopStatus?coopId=13&status=PENDING
Ex: http://cooperator-backend-260.herokuapp.com/setCoopStatus?coopId=13
Ex: http://cooperator-backend-260.herokuapp.com/allCoopsByStudent?coopId=13
Ex: http://cooperator-backend-260.herokuapp.com/createCourse?courseName=ECSE321
Ex: http://cooperator-backend-260.herokuapp.com/deleteCourse?courseId=1
Ex: http://cooperator-backend-260.herokuapp.com/createStudent?firstName=john&lastName=apple
For all create, these are the parameters
| Parameters | Description |
|---|---|
| name | Name of the document |
| dueDate | Due date of the document, formatted MM/dd/yyyy |
| coopId | Id of the document it should be attached to |
| reportType | The type of report the student should submit ReportType { TWO_WEEKS, TERM_SPECIFIC, EVALUATION } |
| employerId | ID of the related employer |
| grade | Boolean: true = passed, false = fail |
Ex: http://cooperator-backend-260.herokuapp.com/createReport?name=second week report&dueDate=04/28/2019&13&reportType=TWO_WEEKS&employerId=1
Ex: http://cooperator-backend-260.herokuapp.com/gradeDocument?documentId=1&grade=true&[email protected]
Wrong param please enter valid information
Service error could not get information
5xx - internal server error
Group 19 BRODEUR Max, DENG Sophie, ELKHOURY Carl, KABA Andre, ZHOU Mia