SchoolAPI

APIs. Namespace

SchoolAPI

Description:

  • SchoolAPI namespace

See:

Methods

(static) *common(req, res)

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

(static) CSchool API(req, res)

Description:

  • 학교 생성 API

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

"admin"
body Object
Properties
Name Type Description
schoolId string
schoolName string
res Object
Properties
Name Type Description
school TSchool

created school
Throws:
status message description
409 SCHOOLID_IN_USE if parameter schoolId is in use

(static) DSchool API(req, res)

Description:

  • 학교 삭제 API; 관련 데이터를 모두 삭제한다

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

"admin"
res Object

(static) RSchool API(req, res)

Description:

  • 학교 조회 API

Version:
  • 2.0.0
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "GET"
url "/schools/:_id"
user Object
res Object
Properties
Name Type Description
school TSchool

(static) RSchools API(req, res)

Description:

  • 학교 목록 조회 API

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

(static) USchoolCalendars API(req, res)

Description:

  • 학교 캘린더 수정 API

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

"admin"|"manager"
body Object
Properties
Name Type Attributes Description
calendar string <nullable>

학사 일정 캘린더
calendarTimetable string <nullable>

시간표 캘린더
res Object
Properties
Name Type Attributes Description
calendar string <nullable>

updated calendar
calendarTimetable string <nullable>

updated calendarTimetable

(static) USchoolFormArchive API(req, res)

Description:

  • 학교 기록 양식 수정 API

Version:
  • 2.0.0
See:
  • models>School for validation
Parameters:
Name Type Description
req Object
Properties
Name Type Description
method "PUT"
url "/schools/:_id/formArchive"
user Object

"admin|"manager"
body Object
Properties
Name Type Description
formArchive Array.<TFormArchiveItem>
res Object
Properties
Name Type Description
formArchive Array.<TFormArchiveItem>

updated formArchive

(static) USchoolLinks API(req, res)

Description:

  • 학교 링크 수정 API

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

"admin"|"manager"
body Object
Properties
Name Type Description
links Array.<TLink>
res Object
Properties
Name Type Description
links Array.<TLink>

updated links