api-v2-controller

Methods

(inner) _generateQueryString(paramsopt)

Source:

app/controllers/api-v2-controller.js, line 576

Parameters:

Name	Type	Attributes	Description
`params`	Array.<string>	<optional>	List of parameters.

(inner) _generateWebformUrls(id, req)

Source:

app/controllers/api-v2-controller.js, line 588

Parameters:

Name	Type	Description
`id`	string	Form id.
`req`	module:api-controller~ExpressRequest	HTTP request

(inner) _render(status, body, res)

Source:

app/controllers/api-v2-controller.js, line 713

Parameters:

Name	Type	Description
`status`	number	HTTP status code
`body`	object \| string	response body
`res`	module:api-controller~ExpressResponse	HTTP response

(inner) _renderPdf(status, id, req, res)

Source:

app/controllers/api-v2-controller.js, line 734

Parameters:

Name	Type	Description
`status`	number	HTTP status code
`id`	string	Enketo ID of survey
`req`	module:api-controller~ExpressRequest	HTTP request
`res`	module:api-controller~ExpressResponse	HTTP response

(inner) _setDefaultsQueryParam(req, res, next)

Source:

app/controllers/api-v2-controller.js, line 508

Parameters:

Name	Type	Description
`req`	module:api-controller~ExpressRequest	HTTP request
`res`	module:api-controller~ExpressResponse	HTTP response
`next`	function	Express callback

(inner) _setGoToHash(req, res, next)

Source:

app/controllers/api-v2-controller.js, line 532

Parameters:

Name	Type	Description
`req`	module:api-controller~ExpressRequest	HTTP request
`res`	module:api-controller~ExpressResponse	HTTP response
`next`	function	Express callback

(inner) _setIframe(req, res, next)

Source:

app/controllers/api-v2-controller.js, line 544

Parameters:

Name	Type	Description
`req`	module:api-controller~ExpressRequest	HTTP request
`res`	module:api-controller~ExpressResponse	HTTP response
`next`	function	Express callback

(inner) _setPage(req, res, next)

Source:

app/controllers/api-v2-controller.js, line 462

Parameters:

Name	Type	Description
`req`	module:api-controller~ExpressRequest	HTTP request
`res`	module:api-controller~ExpressResponse	HTTP response
`next`	function	Express callback

(inner) _setQuotaUsed(req, res, next)

Source:

app/controllers/api-v2-controller.js, line 440

Parameters:

Name	Type	Description
`req`	module:api-controller~ExpressRequest	HTTP request
`res`	module:api-controller~ExpressResponse	HTTP response
`next`	function	Express callback

(inner) _setReturnQueryParam(req, res, next)

Source:

app/controllers/api-v2-controller.js, line 562

Parameters:

Name	Type	Description
`req`	module:api-controller~ExpressRequest	HTTP request
`res`	module:api-controller~ExpressResponse	HTTP response
`next`	function	Express callback

(inner) authCheck(req, res, next)

Source:

app/controllers/api-v2-controller.js, line 144

Parameters:

Name	Type	Description
`req`	module:api-controller~ExpressRequest	HTTP request
`res`	module:api-controller~ExpressResponse	HTTP response
`next`	function	Express callback

(inner) cacheInstance(req, res, next)

Source:

app/controllers/api-v2-controller.js, line 352

Parameters:

Name	Type	Description
`req`	module:api-controller~ExpressRequest	HTTP request
`res`	module:api-controller~ExpressResponse	HTTP response
`next`	function	Express callback

(inner) deactivateSurvey(req, res, next)

Source:

app/controllers/api-v2-controller.js, line 257

Parameters:

Name	Type	Description
`req`	module:api-controller~ExpressRequest	HTTP request
`res`	module:api-controller~ExpressResponse	HTTP response
`next`	function	Express callback

(inner) emptySurveyCache(req, res, next)

Source:

app/controllers/api-v2-controller.js, line 279

Parameters:

Name	Type	Description
`req`	module:api-controller~ExpressRequest	HTTP request
`res`	module:api-controller~ExpressResponse	HTTP response
`next`	function	Express callback

(inner) getExistingSurvey(req, res, next)

Source:

app/controllers/api-v2-controller.js, line 177

Parameters:

Name	Type	Description
`req`	module:api-controller~ExpressRequest	HTTP request
`res`	module:api-controller~ExpressResponse	HTTP response
`next`	function	Express callback

(inner) getList(req, res, next)

Source:

app/controllers/api-v2-controller.js, line 322

Parameters:

Name	Type	Description
`req`	module:api-controller~ExpressRequest	HTTP request
`res`	module:api-controller~ExpressResponse	HTTP response
`next`	function	Express callback

(inner) getNewOrExistingSurvey(req, res, next)

Source:

app/controllers/api-v2-controller.js, line 207

Parameters:

Name	Type	Description
`req`	module:api-controller~ExpressRequest	HTTP request
`res`	module:api-controller~ExpressResponse	HTTP response
`next`	function	Express callback

(inner) getNumber(req, res, next)

Source:

app/controllers/api-v2-controller.js, line 296

Parameters:

Name	Type	Description
`req`	module:api-controller~ExpressRequest	HTTP request
`res`	module:api-controller~ExpressResponse	HTTP response
`next`	function	Express callback

(inner) getVersion(req, res)

Source:

app/controllers/api-v2-controller.js, line 134

Parameters:

Name	Type	Description
`req`	module:api-controller~ExpressRequest	HTTP request
`res`	module:api-controller~ExpressResponse	HTTP response

(inner) removeInstance(req, res, next)

Source:

app/controllers/api-v2-controller.js, line 418

Parameters:

Name	Type	Description
`req`	module:api-controller~ExpressRequest	HTTP request
`res`	module:api-controller~ExpressResponse	HTTP response
`next`	function	Express callback