{
"status": 1,
"code": 100,
"data": "<requested data>"
}
{
"status": 0,
"code": "<error code>",
"msg": "<reason for invalid request>"
}
-
./account/student/register
: student register- Method
POST
-
Request
email
: Stringusername
: StringphoneNumber
: longfirstName
: StringlastName
: Stringpwd
: StringunderGradSchool
: StringoverallGPA
: FloattoeflScore
: IntegerGREScore
: IntegerresearchExp
: StringinternExp
: StringmajorGPA
: Float
-
Response
data
- Student Type
-
Error code
001
: Email taken
-
- Method
-
./account/instructor/register
: instructor register- Method
GET
- Request: None
- Response
data
- List
Institution
Type
- List
- Error code: None
- Method
POST
- Request
email
: StringphoneNumber
: LonginstitutionName
: StringfirstName
: StringlastName
: Stringpwd
: Stringeducation
: String
- Response
data
- Instructor Type
- Error code
001
: Email taken002
: Institution Not Exist
- Request
- Method
-
./account/student/login
: student log in- Method
POST
- Request
email
: Stringpwd
: String
- Response
data
:- Student Type
- Error code
002
: Incorrect password003
: Email not registered
- Request
- Method
-
./account/student/profile
: student update profile- Method
POST
- Request
email
: Stringusername
: StringphoneNumber
: longfirstName
: StringlastName
: Stringpwd
: StringunderGradSchool
: StringoverallGPA
: FloattoeflScore
: IntegerGREScore
: IntegerresearchExp
: StringinternExp
: StringmajorGPA
: Float
- Response
data
- Student Type
- Error code
001
: Email Taken
- Request
- Method
-
./account/instructor/login
: staff log in- Method
POST
- Request
email
: String, the email staff used to registerpwd
: String, user's password
- Response
data
- Instructor Type
- Error code
002
: Incorrect password003
: Email not registered
- Request
- Method
-
./account/instructor/profile
: instructor update profile- Method
GET
- Request: None
- Response
data
- List
Institution
Type
- List
- Error code: None
- Method
POST
- Request
email
: StringphoneNumber
: LonginstitutionName
: StringfirstName
: StringlastName
: Stringpwd
: Stringeducation
: String
- Response
data
- Instructor Type
- Error code
001
: Email Taken
- Request
- Method
./homepage/student/stars/{studentId}
: student view starred program- Method
GET
- Request
studentId
: Long
- Response
data
: ListProgram
Type (nullable)
- Error code: None
- Request
- Method
./homepage/student/contract/{studentId}
: check contract- Method
GET
- Request:
studentId
: Long
- Response
data
: ListContract
Type (nullable)
- Error Code: None
- Request:
- Method
./homepage/student/contract
: check contract- Method
POST
- Request:
contractId
: Longstatus
: StringstudentId
: Long
- Response
data
: ListContract
Type (nullable)
- Error Code: None
- Request:
- Method
-
./homepage/instructor/enrolledStudents/{institutionId}
: check all student in the institution- Method
GET
- Request:
institutionId
: Long
- Response
data
: ListStudent
Type (nullable)
- Error Code: None
- Request:
- Method
-
./homepage/instructor/contract
: send a contract to the student- Method
POST
- Request:
studentEmail
: StringinstructorId
: LonginstitutionId
: Longcontent
: String
- Response
data
:Contract
Type (all registered students’ email)
- Error Code:
003
: Email not registered
- Request:
- Method
-
./homepage/instructor/institutionInfo/{institutionId}
: view the information of the institution- Method
GET
- Request:
institutionName
:String
- Response
data
: Institution Type
- Error Code: None
- Request:
- Method
-
./programs/{schoolName}/{programName}
- Method:
GET
: view programs with or without keywords- Request
schoolName
: String,programName
: String
- Response
data
: ListProgram
Type
- Error code: None
- Request
- Method:
-
./programs/specificProgram/{programId}
-
Method:
Get
: view specific program- Request
programId
: Long
- Response
data
:- Program Type
- Boolean (starred or not)
- Error code: None
- Request
-
Method:
POST
: star the program- Request
studentId
: LongprogramId
: Long
- Response
data
: Star type
- Error code: None
- Request
-
Method:
DELETE
: cancel starring the program- Request
studentId
: LongprogramId
: Long
- Response: None
- Request
-
-
./Programs/SpecificSchool
- Method:
Get
: view specific school page- Request
schoolName
: String
- Response
data
:- List
Program
Type
- List
- Error code: None
- Request
- Method:
-
./institutions/{institutionName}
- Method:
GET
: view selected institutions- Request:
*
name
: String - Response
data
: ListInstitution
Type
- Error code: None
- Request:
*
- Method:
-
./institutions/specificInstitution/{institutionName}/{studentId}
- Method:
GET
: view specific institution- Request:
institutionName
: StringstudentId
: Long, if(studentId==0) {the user is not logged-in student}
- Response
data
:institution
: Institution Typeratings
: ListFloat
Typecomments
: ListComment
Typeratable
: Boolean
- Error code:
*
001
: Institution Doesn't Exist
- Request:
- Method:
-
./institutions/specificInstitution/rating
- Method:
POST
: post ratings- Request:
institutionId
: StringstudentId
: LongoverallRating
: Integercriteria1Rating
: Integercriteria2Rating
: Integercriteria3Rating
: Integercriteria4Rating
: Integercriteria5Rating
: Integercriteria6Rating
: Integerreview
: String
- Response
data
: Rating Type
- Error code: None
- Request:
- Method:
-
./institutions/specificInstitution/comment
- Method:
POST
: comment rating- Request:
ratingId
: IntegeruserName
: String (the commentor's name ; don't need the user of the original comment/rating)parentId
: Integer nullable (the commentId of its parent comment)content
: String
- Response
data
: Track Type
- Error code: None
- Request:
- Method:
-
./institutions/specificInsitution/team/{insitutionName}
- Method:
GET
: view all the team members of the institution- Request:
institutionName
: String
- Response
data
: ListInstructor
Type
- Error Code: None
- Request:
- Method:
-
./applicationResult/program/{schoolName}/{programName}
- Method:
GET
:- Request:
schoolName
: String,programName
: String
- Response
data
: List Type
- Error Code: None
- Request:
- Method:
POST
: upload the program info- Request:
programId
: String
- Response
data
: Program Type
- Error Code: None
- Request:
- Method:
-
./applicationResult/personalInfo
-
Method:
GET
:- Request: None
- Response:
data
: ListInstitution
Type
- Error Code: None
-
Method:
POST
: upload personal info- Request:
programId
: StringinstructorName
: String nullableinstitutionName
: String nullable (Choose from given names, no need for check)status
: Boolean (success or fail)underGradSchool
: StringoverallGPA
: FloattoeflScore
: IntegerGREScore
: IntegerresearchExp
: StringinternExp
: StringmajorGPA
: Float
- Response
data
: Application Type
- Error Code: None
- Request:
-