EnrollmentAPI

APIs. Namespace

EnrollmentAPI

Description:

  • EnrollmentAPI namespace

See:

Methods

(static) *common(req, res)

Parameters:
Name Type Description
req Object
res Object
Throws:
status message description
404 ENROLLMENT_NOT_FOUND if enrollment is not found

(static) CEnrollment API(req, res)

Description:

  • 수강신청 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "POST"
url "/enrollments"
user Object
body Object
Properties
Name Type Attributes Description
syllabus string

ObjectId of syllabus
registration string

ObjectId of registration
socketId string <nullable>
res Object
Throws:
status message description
409 ENROLLMENT_IN_USE if enrollment is already made
409 STUDENTS_FULL if syllabus.limit!==0 and syllabus.count>=syllabus.limit
409 TIME_DUPLICATED if time is duplicated

(static) DEnrollment API(req, res)

Description:

  • 수강 취소 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "DELETE"
url "/enrollments/:_id"
user Object
res Object

(static) REnrollment API(req, res)

Description:

  • 수강 정보 조회 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "GET"
url "/enrollments/:_id"
user Object
res Object
Properties
Name Type Description
enrollment Object

(static) REnrollments API(req, res)

Description:

  • 수강 정보 목록 조회 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "GET"
url "/enrollments"
query Object
Properties
Name Type Attributes Description
syllabus string <nullable>

ObjectId of syllabus
season string <nullable>

ObjectId of season
student string <nullable>

ObjectId of student
user Object
res Object
Properties
Name Type Description
enrollments Array.<Object>

(static) REnrollmentsWithEvaluation API(req, res)

Description:

  • 평가 목록 조회 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "GET"
url "/enrollments/evaluations"
query Object
Properties
Name Type Attributes Description
syllabus string <nullable>

ObjectId of syllabus
school string <nullable>

ObjectId of school
student string <nullable>

ObjectId of student
user Object
res Object
Properties
Name Type Attributes Description
enrollments Array.<Object>
syllabus Object <nullable>

if req.query.syllabus is used

(static) UEnrollmentMemo API(req, res)

Description:

  • 수강 정보 메모 수정 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "PUT"
url "/enrollments/:_id/memo"
user Object
body Object
Properties
Name Type Description
memo string
res Object

(static) UEvaluation API(req, res)

Description:

  • 평가 수정 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "PUT"
url "/enrollments/:_id/evaluation"
user Object
body Object
Properties
Name Type Description
evaluation Object
res Object

(static) UHideEnrollmentFromCalendar API(req, res)

Description:

  • 캘린더(수강 중인 수업)에서 숨김 설정 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "PUT"
url "/enrollments/:_id/hide"
user Object
body Object
res Object

(static) UShowEnrollmentOnCalendar API(req, res)

Description:

  • 캘린더(수강 중인 수업)에서 조회 설정 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "PUT"
url "/enrollments/:_id/show"
user Object
body Object
res Object