RegistrationAPI

APIs. Namespace

RegistrationAPI

Description:

  • RegistrationAPI namespace

See:

Methods

(static) *common(req, res)

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

(static) CCopyRegistrations API(req, res)

Description:

  • 학기 등록 정보 복제 API

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

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

ObjectId of season to cpoy registrations
toSeason string

ObjectId of season to paste registrations
res Object
Properties
Name Type Description
registrations Object

pasted registrations

(static) CRegistration API(req, res)

Description:

  • 학기 등록 정보 생성 API

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

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

ObjectId of season
user string

ObjectId of user
role "teacher" | "student"
grade string <nullable>
group string <nullable>
teacher string <nullable>

ObjectId of teacher
subTeacher string <nullable>

ObjectId of subTeacher
res Object
Properties
Name Type Description
season Object

created season
Throws:
status message description
409 REGISTRATION_IN_USE if registration is already made

(static) DRegistration API(req, res)

Description:

  • 학기 등록 정보 삭제 API;

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

"admin"|"manager"
res Object

(static) RRegistration API(req, res)

Description:

  • 학기 등록 정보 조회 API;

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

(static) RRegistrations API(req, res)

Description:

  • 학기 등록 정보 목록 조회 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "GET"
url "/registrations"
query Object
Properties
Name Type Attributes Description
user string <nullable>
school string <nullable>
season string <nullable>
role string <nullable>
user Object
res Object
Properties
Name Type Description
registrations Array.<Object>

(static) URegistration API(req, res)

Description:

  • 학기 등록 정보 수정 API;

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

"admin"|"manager"
body Object
Properties
Name Type Attributes Description
role string
grade string <nullable>
group string <nullable>
teacher string <nullable>

ObjectId of teacher
subTeacher string <nullable>

ObjectId of subTeacher
res Object
Properties
Name Type Description
registration Object

updated registration