AcademyAPI

Description:

AcademyAPI namespace

See:

TAcademy in Models.Academy

Methods

(static) *common(req, res)

Parameters:

Name	Type	Description
`req`	Object
`res`	Object

Throws:

status	message	description
404	ACADEMY_NOT_FOUND	if academy is not found

(static) CAcademy API(req, res)

Description:

아카데미 생성 API; academy document와 academy DB를 생성한다

Version:

2.0.0

See:

Models.Academy for validation

Parameters:

Name Type Description

req

Object

Properties

Name Type Description

method "POST"

url "/academies"

user

Object

"admin"

body

Object

Properties

Name	Type	Attributes
`academyId`	string
`academyName`	string
`adminId`	string
`adminName`	string
`email`	string	<nullable>
`tel`	string	<nullable>

res

Object

Properties

Name Type Description

academy

TAcademy

created academy

admin

Object

created admin

Properties

Name	Type	Description
`userId`	string
`userName`	string
`password`	string

Throws:

status	message	description
409	ACADEMYID_IN_USE	if parameter academyID is in use

(static) CAcademyBackup API(req, res)

Description:

아카데미 백업 생성 API; 특정 모델의 아카데미 도큐먼트를 전체 조회하여 s3에 업로드한다

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name Type Description

method "POST"

url "/academies/:academyId/backup"

params

Object

Properties

Name	Type	Description
`academyId`	string

user

Object

"owner"

body

Object

Properties

Name	Type	Description
`models`	Array.<TModel>

res

Object

Properties

Name	Type	Description
`logs`	Array.<string>

(static) DAcademy API(req, res)

Description:

아카데미 삭제 API; 아카데미 DB의 모든 데이터를 삭제한다

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name Type Description

method "DELETE"

url "/academies/:academyId"

params

Object

Properties

Name	Type	Description
`academyId`	string

user

Object

"owner"

res Object

(static) DAcademyBackup API(req, res)

Description:

아카데미 백업 삭제 API

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name Type Description

method "DELETE"

url "/academies/:academyId/backup"

params

Object

Properties

Name	Type	Description
`academyId`	string

query

Object

Properties

Name	Type	Description
`title`	string	backup title ex) "202312-232"

user

Object

"owner"

res Object

(static) RAcademies API(req, res)

Description:

아카데미 목록 조회 API

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name	Type	Description
`method`	"GET"
`url`	"/academies"
`user`	Object	"owner"\|"guest"

res

Object

Properties

Name	Type	Description
`academies`	Array.<TAcademy>	academy list

(static) RAcademy API(req, res)

Description:

아카데미 조회 API

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name Type Description

method "GET"

url "/academies"

query

Object

Properties

Name	Type	Description
`academyId`	string

user

Object

"owner"|"guest"

res

Object

Properties

Name	Type	Description
`academy`	TAcademy

(static) RAcademyBackup API(req, res)

Description:

아카데미 백업 조회 API

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name Type Description

method "GET"

url "/academies/:academyId/backup"

params

Object

Properties

Name	Type	Description
`academyId`	string

query

Object

Properties

Name	Type	Description
`title`	string	backup title ex) "202312-232"

user

Object

"owner"

res

Object

Properties

Name	Type	Description
`backup`	Array.<TBackupData>

(static) RAcademyBackupList API(req, res)

Description:

아카데미 백업 목록 조회 API; s3에 업로드된 백업 목록을 조회한다

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name Type Description

method "GET"

url "/academies/:academyId/backup"

params

Object

Properties

Name	Type	Description
`academyId`	string

user

Object

"owner"

res

Object

Properties

Name	Type	Description
`backupList`	Array.<TBackup>

(static) RAcademyDocument API(req)

Description:

아카데미 데이터 조회 API

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name Type Description

method "GET"

url "/academies/:academyId/:docType/:docId"

params

Object

Properties

Name	Type	Description
`academyId`	string
`docType`	string	ex) "schools", "seasons", etc.
`docId`	string	objectId of document

user

Object

"owner"

res.document Object

(static) RAcademyDocuments API(req)

Description:

아카데미 데이터 목록 조회 API

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name Type Description

method "GET"

url "/academies/:academyId/:docType"

params

Object

Properties

Name	Type	Description
`academyId`	string
`docType`	string	ex) "schools", "seasons", etc.

query

Object

자유롭게 요청 가능

user

Object

"owner"

res.documents Array.<Object>

(static) UAcademyEmail API(req, res)

Description:

아카데미 이메일 변경 API

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name Type Description

method "PUT"

url "/academies/:academyId/email"

params

Object

Properties

Name	Type	Description
`academyId`	string

user

Object

"owner"

body

Object

Properties

Name	Type	Attributes	Description
`email`	string	<nullable>

res

Object

Properties

Name	Type	Description
`academy`	TAcademy	updated academy

(static) UAcademyTel API(req, res)

Description:

아카데미 전화번호 변경 API

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name Type Description

method "PUT"

url "/academies/:academyId/tel"

params

Object

Properties

Name	Type	Description
`academyId`	string

user

Object

"owner"

body

Object

Properties

Name	Type	Attributes	Description
`tel`	string	<nullable>

res

Object

Properties

Name	Type	Description
`academy`	TAcademy	updated academy

(static) UActivateAcademy API(req, res)

Description:

아카데미 활성화 API

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name Type Description

method "PUT"

url "/academies/:academyId/activate"

params

Object

Properties

Name	Type	Description
`academyId`	string

user

Object

"owner"

body Object

res

Object

Properties

Name	Type	Description
`academy`	TAcademy	activated academy

(static) UInactivateAcademy API(req, res)

Description:

아카데미 비활성화 API

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name Type Description

method "PUT"

url "/academies/:academyId/inactivate"

params

Object

Properties

Name	Type	Description
`academyId`	string

user

Object

"owner"

body Object

res

Object

Properties

Name	Type	Description
`academy`	TAcademy	inactivated academy

(static) URestoreAcademy API(req, res)

Description:

아카데미 복구 API; 특정 모델의 아카데미 도큐먼트를 모두 교체한다

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name Type Description

method "PUT"

url "/academies/:academyId/restore"

params

Object

Properties

Name	Type	Description
`academyId`	string

user

Object

"owner"

body

Object

Properties

Name	Type	Description
`model`	string	ex) "users", "schools", ...
`documents`	Array.<Object>

res Object

Type Definitions

TBackup

Properties:

Name	Type	Description
`backupTitle`	string	ex) 20231232-12303
`key`	string	ex) "{{bucket}}/{{academyId}}/backup/{{backupTitle}}"

TBackupData

Properties:

Name	Type	Description
`title`	string	ex) users.json
`key`	string	ex) "{{bucket}}/{{academyId}}/backup/{{backupTitle}}/{{title}}"
`size`	number
`lastModified`	Date

TModel

Properties:

Name	Type	Description
`title`	string	ex) "users", "schools", etc.