Skip to content

Latest commit

 

History

History
342 lines (306 loc) · 9.45 KB

API_documentation.md

File metadata and controls

342 lines (306 loc) · 9.45 KB
Raw

API documentation

Response definition

Response for valid request

{
"status": 1,
"code": 100,
"data": "<requested data>"
}

Response for invalid request

{
"status": 0,
"code": "<error code>",
"msg": "<reason for invalid request>"
}

API list

./account: authenticate and update profile

  • ./account/student/register: student register

    • Method POST

      • Request

        • email: String
        • username: String
        • phoneNumber: long
        • firstName: String
        • lastName: String
        • pwd: String
        • underGradSchool: String
        • overallGPA: Float
        • toeflScore: Integer
        • GREScore: Integer
        • researchExp: String
        • internExp: String
        • majorGPA: Float

      • Response

        • data
          • Student Type

      • Error code

        • 001: Email taken

  • ./account/instructor/register: instructor register

    • Method GET
      • Request: None
      • Response
        • data
          • List Institution Type
      • Error code: None
    • Method POST
      • Request
        • email: String
        • phoneNumber: Long
        • institutionName: String
        • firstName: String
        • lastName: String
        • pwd: String
        • education: String
      • Response
        • data
          • Instructor Type
      • Error code
        • 001: Email taken
        • 002: Institution Not Exist

  • ./account/student/login: student log in

    • Method POST
      • Request
        • email: String
        • pwd: String
      • Response
        • data:
          • Student Type
      • Error code
        • 002: Incorrect password
        • 003: Email not registered

  • ./account/student/profile: student update profile

    • Method POST
      • Request
        • email: String
        • username: String
        • phoneNumber: long
        • firstName: String
        • lastName: String
        • pwd: String
        • underGradSchool: String
        • overallGPA: Float
        • toeflScore: Integer
        • GREScore: Integer
        • researchExp: String
        • internExp: String
        • majorGPA: Float
      • Response
        • data
          • Student Type
      • Error code
      • 001: Email Taken

  • ./account/instructor/login: staff log in

    • Method POST
      • Request
        • email: String, the email staff used to register
        • pwd: String, user's password
      • Response
        • data
          • Instructor Type
      • Error code
        • 002: Incorrect password
        • 003: Email not registered

  • ./account/instructor/profile: instructor update profile

    • Method GET
      • Request: None
      • Response
        • data
          • List Institution Type
    • Error code: None
    • Method POST
      • Request
        • email: String
        • phoneNumber: Long
        • institutionName: String
        • firstName: String
        • lastName: String
        • pwd: String
        • education: String
      • Response
        • data
          • Instructor Type
      • Error code
        • 001: Email Taken

./homepage/student: Student homepage after log in

  • ./homepage/student/stars/{studentId}: student view starred program
    • Method GET
      • Request
        • studentId: Long
      • Response
        • data: List Program Type (nullable)
      • Error code: None
  • ./homepage/student/contract/{studentId}: check contract
    • Method GET
      • Request:
        • studentId: Long
      • Response
        • data: List Contract Type (nullable)
      • Error Code: None
  • ./homepage/student/contract: check contract
    • Method POST
      • Request:
        • contractId: Long
        • status: String
        • studentId: Long
      • Response
        • data: List Contract Type (nullable)
      • Error Code: None

./homepage/instructor: instructor homepage after log in

  • ./homepage/instructor/enrolledStudents/{institutionId}: check all student in the institution

    • Method GET
      • Request:
        • institutionId: Long
      • Response
        • data: List Student Type (nullable)
      • Error Code: None

  • ./homepage/instructor/contract: send a contract to the student

    • Method POST
      • Request:
        • studentEmail: String
        • instructorId: Long
        • institutionId: Long
        • content: String
      • Response
        • data: Contract Type (all registered students’ email)
      • Error Code:
        • 003: Email not registered

  • ./homepage/instructor/institutionInfo/{institutionId}: view the information of the institution

    • Method GET
      • Request:
        • institutionName:String
      • Response
        • data: Institution Type
      • Error Code: None

./programs: view programs

  • ./programs/{schoolName}/{programName}

    • Method: GET: view programs with or without keywords
      • Request
        • schoolName: String,
        • programName: String
      • Response
        • data: List Program Type
      • Error code: None

  • ./programs/specificProgram/{programId}

    • Method: Get: view specific program

      • Request
        • programId: Long
      • Response
        • data:
          • Program Type
          • Boolean (starred or not)
      • Error code: None

    • Method: POST: star the program

      • Request
        • studentId: Long
        • programId: Long
      • Response
        • data: Star type
      • Error code: None

    • Method: DELETE: cancel starring the program

      • Request
        • studentId: Long
        • programId: Long
      • Response: None

  • ./Programs/SpecificSchool

    • Method: Get: view specific school page
      • Request
        • schoolName: String
      • Response
        • data:
          • List Program Type
      • Error code: None

./institutions: view institutions

  • ./institutions/{institutionName}

    • Method: GET: view selected institutions
      • Request: *name: String
      • Response
        • data: List Institution Type
      • Error code: None

  • ./institutions/specificInstitution/{institutionName}/{studentId}

    • Method: GET: view specific institution
      • Request:
        • institutionName: String
        • studentId: Long, if(studentId==0) {the user is not logged-in student}
      • Response
        • data:
          • institution: Institution Type
          • ratings: List Float Type
          • comments: List Comment Type
          • ratable: Boolean
      • Error code: *001: Institution Doesn't Exist

  • ./institutions/specificInstitution/rating

    • Method: POST: post ratings
      • Request:
        • institutionId: String
        • studentId: Long
        • overallRating: Integer
        • criteria1Rating: Integer
        • criteria2Rating: Integer
        • criteria3Rating: Integer
        • criteria4Rating: Integer
        • criteria5Rating: Integer
        • criteria6Rating: Integer
        • review: String
      • Response
        • data: Rating Type
      • Error code: None

  • ./institutions/specificInstitution/comment

    • Method: POST: comment rating
      • Request:
        • ratingId: Integer
        • userName: 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

  • ./institutions/specificInsitution/team/{insitutionName}

    • Method: GET: view all the team members of the institution
      • Request:
        • institutionName: String
      • Response
        • data: List Instructor Type
      • Error Code: None

./applicationResult: upload applications

  • ./applicationResult/program/{schoolName}/{programName}

    • Method: GET:
      • Request:
        • schoolName: String,
        • programName: String
      • Response
        • data: List Type
      • Error Code: None
    • Method: POST: upload the program info
      • Request:
        • programId: String
      • Response
        • data: Program Type
      • Error Code: None

  • ./applicationResult/personalInfo

    • Method: GET:

      • Request: None
      • Response:
        • data: List Institution Type
      • Error Code: None

    • Method: POST: upload personal info

      • Request:
        • programId: String
        • instructorName: String nullable
        • institutionName: String nullable (Choose from given names, no need for check)
        • status: Boolean (success or fail)
        • underGradSchool: String
        • overallGPA: Float
        • toeflScore: Integer
        • GREScore: Integer
        • researchExp: String
        • internExp: String
        • majorGPA: Float
      • Response
        • data: Application Type
      • Error Code: None