SeasonAPI

APIs. Namespace

SeasonAPI

Description:

  • SeasonAPI namespace

See:

Methods

(static) *common(req, res)

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

(static) CSeason API(req, res)

Description:

  • 학기 생성 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "POST"
url "/seasons"
user Object

"admin"|"manager"
body Object
Properties
Name Type Attributes Description
school string

ObjectId of school(sid)
year string
term string
period string
Properties
Name Type Description
start string

"YYYY-MM-DD"
end string

"YYYY-MM-DD"
copyFrom string <nullable>

ObjectId of season to copy from
res Object
Properties
Name Type Description
season Object

created season
Throws:
status message description
409 YEAR_TERM_IN_USE if parameters year and term are in use

(static) CSeasonPermissionException API(req, res)

Description:

  • 학기 권한 예외 추가 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "POST"
url "/seasons/:_id/permission/:type/exceptions"
params Object
Properties
Name Type Description
_id string

season objectId
type "syllabus" | "enrollment" | "evaluation"
user Object

"admin"|"manager"
body Object
Properties
Name Type Description
registration string

registration ObjectId
isAllowed boolean
res Object
Properties
Name Type Description
season Object

updated season

(static) DSeason API(req, res)

Description:

  • 시즌 삭제 API; 시즌 관련 정보를 모두 삭제한다

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

"admin"|"manager"
res Object

(static) DSeasonPermissionException API(req, res)

Description:

  • 학기 권한 예외 삭제 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "DELETE"
url "/seasons/:_id/permission/:type/exceptions"
params Object
Properties
Name Type Description
_id string

season objectId
type "syllabus" | "enrollment" | "evaluation"
query Object
Properties
Name Type Description
registration string
user Object

"admin"|"manager"
res Object
Properties
Name Type Description
season Object

updated season

(static) RSeason API(req, res)

Description:

  • 학기 조회 API; 간략한 등록 정보 목록을 함께 조회한다

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

school objectId
user Object
res Object
Properties
Name Type Description
season Object
registrations Array.<Object>

(static) RSeasons API(req, res)

Description:

  • 학기 목록 조회 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "GET"
url "/seasons"
user Object
res Object
Properties
Name Type Description
seasons Array.<Object>

(static) UActivateSeason API(req, res)

Description:

  • 시즌 활성화 API; 시즌 등록 정보도 함께 활성화한다

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "PUT"
url "/seasons/:_id/activate"
user Object

"admin"|"manager"
body Object
res Object
Properties
Name Type Description
season Object

activated season

(static) UInactivateSeason API(req, res)

Description:

  • 시즌 비활성화 API; 시즌 등록 정보도 함께 비활성화한다

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "PUT"
url "/seasons/:_id/inactivate"
user Object

"admin"|"manager"
body Object
res Object
Properties
Name Type Description
season Object

inactivated season

(static) USeasonClassrooms API(req, res)

Description:

  • 학기 강의실 목록 수정 API

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

"admin"|"manager"
res Object
Properties
Name Type Description
season Object

updated season

(static) USeasonFormEvaluation API(req, res)

Description:

  • 학기 평가 양식 수정 API

Version:
  • 2.0.0
See:
  • models>Season for validation
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "PUT"
url "/seasons/:_id/form/evaluation"
body Object
Properties
Name Type Description
formEvaluation Array.<Object>
user Object

"admin"|"manager"
res Object
Properties
Name Type Description
season Object

updated season

(static) USeasonFormSyllabus API(req, res)

Description:

  • 학기 강의계획서 양식 수정 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "PUT"
url "/seasons/:_id/form/syllabus"
body Object
Properties
Name Type Description
form string

form ObjectId
user Object

"admin"|"manager"
res Object
Properties
Name Type Description
season Object

updated season

(static) USeasonFormTimetable API(req, res)

Description:

  • 학기 시간표 양식 수정 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "PUT"
url "/seasons/:_id/form/timetable"
body Object
Properties
Name Type Description
form string

form ObjectId
user Object

"admin"|"manager"
res Object
Properties
Name Type Description
season Object

updated season

(static) USeasonPeriod API(req, res)

Description:

  • 학기 기간 수정 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "PUT"
url "/seasons/:_id/period"
body Object
Properties
Name Type Attributes Description
start string <nullable>

YYYY-MM-DD
end string <nullable>

YYYY-MM-DD
user Object

"admin"|"manager"
res Object
Properties
Name Type Description
season Object

updated season

(static) USeasonPermission API(req, res)

Description:

  • 학기 권한 수정 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "PUT"
url "/seasons/:_id/permission/:type"
params Object
Properties
Name Type Description
_id string

season objectId
type "syllabus" | "enrollment" | "evaluation"
user Object

"admin"|"manager"
body Object
Properties
Name Type Attributes Description
teacher boolean <nullable>
student boolean <nullable>
res Object
Properties
Name Type Description
season Object

updated season

(static) USeasonSubjects API(req, res)

Description:

  • 학기 교과목 목록 수정 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "PUT"
url "/seasons/:_id/subjects"
body Object
Properties
Name Type Description
label Array.<string>
data Array.<Array.<string>>
user Object

"admin"|"manager"
res Object
Properties
Name Type Description
season Object

updated season