SyllabusAPI

APIs. Namespace

SyllabusAPI

Description:

  • SyllabusAPI namespace

See:

Methods

(static) *common(req, res)

Parameters:
Name Type Description
req Object
res Object
Throws:
status message description
404 SYLLABUS_NOT_FOUND if syllabus is not found
403 PERMISSION_DENIED user has no permission for create/update/delete syllabus

(static) CSyllabus API(req, res)

Description:

  • 강의계획서 생성 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "POST"
url "/syllabuses"
user Object
body Object
Properties
Name Type Description
season string

ObjectId of season
subject Array.<string>
classTitle string
teachers Array.<Object>
time Array.<Object>
classroom string
point number
limit number
info Object
res Object
Properties
Name Type Description
syllabus Object

created syllabus
Throws:
status message description
409 CLASSROOM_IN_USE if classroom is in use

(static) DSyllabus API(req, res)

Description:

  • 강의계획서 삭제 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "DELETE"
url "/syllabuses/:_id"
user Object
res Object
Throws:
status message description
403 SYLLABUS_ENROLLED_ALREADY if syllabus has at least one enrollment

(static) RSyllabus API(req, res)

Description:

  • 강의계획서 조회 API

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

(static) RSyllabuses API(req, res)

Description:

  • 강의계획서 목록 조회 API

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

ObjectId of season
classroom string <nullable>
confirmed string <nullable>
user string <nullable>
teacher string <nullable>
student string <nullable>
user Object
res Object
Properties
Name Type Description
syllabuses Object
enrollments Object

if req.query.student is given

(static) UCancelConfirmSyllabus API(req, res)

Description:

  • 강의계획서 승인 취소 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "DELETE"
url "/syllabuses/:_id/confirm"
user Object
body Object
res Object
Properties
Name Type Description
syllabus Object

updated syllabus

(static) UConfirmSyllabus API(req, res)

Description:

  • 강의계획서 승인 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "POST"
url "/syllabuses/:_id/confirm"
user Object
body Object
res Object
Properties
Name Type Description
syllabus Object

updated syllabus

(static) UHideSyllabusFromCalendar API(req, res)

Description:

  • 캘린더(멘토링 수업)에서 숨김 설정 API

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

(static) UShowSyllabusOnCalendar API(req, res)

Description:

  • 캘린더(멘토링 수업)에서 조회 설정 API

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

(static) USyllabus API(req, res)

Description:

  • 강의계획서 수정 API; 멘토가 이미 수강생이 있는 강의계획서를 수정하는 경우 시간, 강의실, 교과목은 변경되지 않는다. 교과목 변경은 USyllabusSubject API 별도 요청 필요.

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "PUT"
url "/syllabuses/:_id"
user Object
body Object
Properties
Name Type Description
subject Array.<string>
classTitle string
teachers Array.<Object>
time Array.<Object>
classroom string
point number
limit number
info Object
res Object
Properties
Name Type Description
syllabus Object

updated syllabus
Throws:
status message description
403 SYLLABUS_CONFIRMED_ALREADY if syllabus is fully confirmed
403 SYLLABUS_ENROLLED_ALREADY if syllabus has at least one enrollment
409 SYLLABUS_COUNT_EXCEEDS_LIMIT if number of enrollments exeeds limit
409 CLASSROOM_IN_USE if classroom is in use

(static) USyllabusSubject API(req, res)

Description:

  • 강의계획서 교과목 수정 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "PUT"
url "/syllabuses/:_id"
user Object
body Object
Properties
Name Type Description
subject Array.<string>
res Object
Properties
Name Type Description
syllabus Object

updated syllabus
changes Object

changes in enrollments.evaluation