import express from 'express';
import controller from '../../controllers/admin/trainingCategory';

const router = express.Router();

// #region /api/admin/trainingCategory/getTrainingCategory apidoc
/**
 * @api {post} /api/admin/trainingCategory/getTrainingCategory Get Training Category
 * @apiVersion 1.0.0
 * @apiName Get Training Category
 * @apiDescription Get Training Category
 * @apiGroup Training Category - Admin
 * @apiParam  {String}          [startIndex]                Optional Start Index
 * @apiParam  {String}          [fetchRecords]              Optional Fetch Records.
 * @apiSuccess (200) {JSON} Result status, message, recordList, totalRecords.
 * @apiSuccessExample {json} Success-200-Response:
 *     HTTP/1.1 200 OK
 *     {
 *          status: 200,
 *          isDisplayMessage: <true/false>, // if the value is true then display message on screen
 *          message: 'Get Training Categories',
 *          recordList: Training Categories,
 *          totalRecords: TotalRecords
 *     }
 * @apiError (500) {JSON} Result message, apiName, apiType, fileName, functionName, lineNumber, typeName, stack.
 * @apiErrorExample {json} Error-500-Response:
 *     HTTP/1.1 500 ERROR
 *     {
 *          status: <error status code>,
 *          isDisplayMessage: <true/false>, // if the value is true then display message on screen
 *          message: <error message>,
 *          error: {
 *              apiName: <api name>,
 *              apiType: <api type>,
 *              fileName: <file name>,
 *              functionName: <function name>,
 *              lineNumber: <line number>,
 *              typeName: <type name>,
 *              stack: <stack>
 *          },
 *          value: <value if any>
 *     }
 */
// #endregion
router.post('/getTrainingCategory', controller.getTrainingCategories);

// #region /api/admin/trainingCategory/insertTrainingCategory apidoc
/**
 * @api {post} /api/admin/trainingCategory/insertTrainingCategory insert Training Category
 * @apiVersion 1.0.0
 * @apiName insert Training Category
 * @apiDescription insert Training Category
 * @apiGroup Training Category - Admin
 * @apiParam  {String}          name                Requires Training Category Name.
 * @apiParam  {String}          parentId         Optional parentId of training category.
 * @apiSuccess (200) {JSON} Result status, message, recordList, totalRecords.
 * @apiSuccessExample {json} Success-200-Response:
 *     HTTP/1.1 200 OK
 *     {
 *          status: 200,
 *          isDisplayMessage: <true/false>, // if the value is true then display message on screen
 *          message: 'insert Training Category',
 *          recordList: Training Categories,
 *          totalRecords: TotalRecords
 *     }
 * @apiError (500) {JSON} Result message, apiName, apiType, fileName, functionName, lineNumber, typeName, stack.
 * @apiErrorExample {json} Error-500-Response:
 *     HTTP/1.1 500 ERROR
 *     {
 *          status: <error status code>,
 *          isDisplayMessage: <true/false>, // if the value is true then display message on screen
 *          message: <error message>,
 *          error: {
 *              apiName: <api name>,
 *              apiType: <api type>,
 *              fileName: <file name>,
 *              functionName: <function name>,
 *              lineNumber: <line number>,
 *              typeName: <type name>,
 *              stack: <stack>
 *          },
 *          value: <value if any>
 *     }
 */
// #endregion
router.post('/insertTrainingCategory', controller.insertTrainingCategory);

// #region /api/admin/trainingCategory/updateTrainingCategroy apidoc
/**
 * @api {post} /api/admin/trainingCategory/updateTrainingCategroy update Training Category
 * @apiVersion 1.0.0
 * @apiName update Training Category
 * @apiDescription update Training Category
 * @apiGroup Training Category - Admin
 * @apiParam  {Integer}         id                  Requires Training Category Id.
 * @apiParam  {String}          name                Requires Training Category Name.
 * @apiParam  {String}          parentId         Optional parentId of training category.
 * @apiSuccess (200) {JSON} Result status, message, recordList, totalRecords.
 * @apiSuccessExample {json} Success-200-Response:
 *     HTTP/1.1 200 OK
 *     {
 *          status: 200,
 *          isDisplayMessage: <true/false>, // if the value is true then display message on screen
 *          message: 'update Training Category',
 *          recordList: Training Categories,
 *          totalRecords: TotalRecords
 *     }
 * @apiError (500) {JSON} Result message, apiName, apiType, fileName, functionName, lineNumber, typeName, stack.
 * @apiErrorExample {json} Error-500-Response:
 *     HTTP/1.1 500 ERROR
 *     {
 *          status: <error status code>,
 *          isDisplayMessage: <true/false>, // if the value is true then display message on screen
 *          message: <error message>,
 *          error: {
 *              apiName: <api name>,
 *              apiType: <api type>,
 *              fileName: <file name>,
 *              functionName: <function name>,
 *              lineNumber: <line number>,
 *              typeName: <type name>,
 *              stack: <stack>
 *          },
 *          value: <value if any>
 *     }
 */
// #endregion
router.post('/updateTrainingCategory', controller.updateTrainingCategory);

// #region /api/admin/trainingCategory/activeInactiveTrainingCategory apidoc
/**
 * @api {post} /api/admin/trainingCategory/activeInactiveTrainingCategory Change Training Category Status
 * @apiVersion 1.0.0
 * @apiName Change Training Category Status
 * @apiDescription Change Training Category Status
 * @apiGroup Training Category - Admin
 * @apiParam  {Integer}         id                  Requires Training Category Id.
 * @apiSuccess (200) {JSON} Result status, message, recordList, totalRecords.
 * @apiSuccessExample {json} Success-200-Response:
 *     HTTP/1.1 200 OK
 *     {
 *          status: 200,
 *          isDisplayMessage: <true/false>, // if the value is true then display message on screen
 *          message: 'Change TrainingCategory Status',
 *          recordList: Training Category,
 *          totalRecords: TotalRecords
 *     }
 * @apiError (500) {JSON} Result message, apiName, apiType, fileName, functionName, lineNumber, typeName, stack.
 * @apiErrorExample {json} Error-500-Response:
 *     HTTP/1.1 500 ERROR
 *     {
 *          status: <error status code>,
 *          isDisplayMessage: <true/false>, // if the value is true then display message on screen
 *          message: <error message>,
 *          error: {
 *              apiName: <api name>,
 *              apiType: <api type>,
 *              fileName: <file name>,
 *              functionName: <function name>,
 *              lineNumber: <line number>,
 *              typeName: <type name>,
 *              stack: <stack>
 *          },
 *          value: <value if any>
 *     }
 */
// #endregion
router.post('/activeInactiveTrainingCategory', controller.activeInactiveTrainingCategory);

// #region /api/admin/trainingCategory/removeTrainingCategory apidoc
/**
 * @api {post} /api/admin/trainingCategory/removeTrainingCategory Remove Training Category
 * @apiVersion 1.0.0
 * @apiName Remove Training Category
 * @apiDescription Remove Training Category
 * @apiGroup Training Category - Admin
 * @apiParam  {Integer}         id                  Requires Training Category Id.
 * @apiSuccess (200) {JSON} Result status, message, recordList, totalRecords.
 * @apiSuccessExample {json} Success-200-Response:
 *     HTTP/1.1 200 OK
 *     {
 *          status: 200,
 *          isDisplayMessage: <true/false>, // if the value is true then display message on screen
 *          message: 'Remove TrainingCategory ',
 *          recordList: Training Category,
 *          totalRecords: TotalRecords
 *     }
 * @apiError (500) {JSON} Result message, apiName, apiType, fileName, functionName, lineNumber, typeName, stack.
 * @apiErrorExample {json} Error-500-Response:
 *     HTTP/1.1 500 ERROR
 *     {
 *          status: <error status code>,
 *          isDisplayMessage: <true/false>, // if the value is true then display message on screen
 *          message: <error message>,
 *          error: {
 *              apiName: <api name>,
 *              apiType: <api type>,
 *              fileName: <file name>,
 *              functionName: <function name>,
 *              lineNumber: <line number>,
 *              typeName: <type name>,
 *              stack: <stack>
 *          },
 *          value: <value if any>
 *     }
 */
// #endregion
router.post('/removeTrainingCategory', controller.removeTrainingCategory);
export = router;