FormAPI

Description:

FormAPI namespace

See:

TForm in Models.Form

Methods

(static) *common(req, res)

Parameters:

Name	Type	Description
`req`	Object
`res`	Object

Throws:

status	message	description
404	FORM_NOT_FOUND	if form is not found

(static) CCopyForm API(req, res)

Description:

양식 복사 생성 API

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name	Type	Description
`method`	"POST"
`url`	"/forms/:_id/copy"
`user`	Object	"admin"\|"manager"
`body`	Object

res

Object

Properties

Name	Type	Description
`form`	Object	copied form

(static) CForm API(req, res)

Description:

양식 생성 API

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name Type Description

method "POST"

url "/forms"

user

Object

"admin"|"manager"

body

Object

Properties

Name	Type	Description
`title`	string
`type`	string
`data`	Array.<Object>

res

Object

Properties

Name	Type	Description
`form`	Object	created form

Throws:

status	message	description
409	TITLE_IN_USE	if title is duplicate

(static) DForm API(req, res)

Description:

양식 삭제 API

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name	Type	Description
`method`	"DELETE"
`url`	"/forms/:_id"
`user`	Object	"admin"\|"manager"

res Object

(static) RForm API(req, res)

Description:

양식 조회 API

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name	Type	Description
`method`	"GET"
`url`	"/forms/:_id"
`user`	Object	"admin"\|"manager"

res

Object

Properties

Name	Type	Description
`form`	Object

(static) RForms API(req, res)

Description:

양식 목록 조회 API

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name Type Description

method "GET"

url "/forms"

query

Object

Properties

Name	Type	Attributes	Description
`type`	string	<nullable>
`archived`	boolean	<nullable>

user

Object

"admin"|"manager"

res

Object

Properties

Name	Type	Description
`forms`	Array.<Object>

(static) UArchiveForm API(req, res)

Description:

양식 보관 API

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name	Type	Description
`method`	"PUT"
`url`	"/forms/:_id/archive"
`user`	Object	"admin"\|"manager"
`body`	Object

res

Object

Properties

Name	Type	Description
`form`	Object	updated form

(static) UForm API(req, res)

Description:

양식 수정 API

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name Type Description

method "PUT"

url "/forms/:_id"

user

Object

"admin"|"manager"

body

Object

Properties

Name	Type	Description
`title`	string
`data`	Array.<Object>

res

Object

Properties

Name	Type	Description
`form`	Object	updated form

(static) URestoreForm API(req, res)

Description:

양식 복원 API

Version:

2.0.0

Parameters:

Name Type Description

req

Object

Properties

Name	Type	Description
`method`	"PUT"
`url`	"/forms/:_id/restore"
`user`	Object	"admin"\|"manager"
`body`	Object

res

Object

Properties

Name	Type	Description
`form`	Object	updated form