|
666 | 666 | * attainment as per Bloom's Taxanomy (L1-L6). |
667 | 667 | */ |
668 | 668 |
|
| 669 | +/** |
| 670 | + * @api {post} /module/add Add Module |
| 671 | + * @apiName AddModule |
| 672 | + * @apiGroup Module |
| 673 | + * |
| 674 | + * @apiBody {Number} [no] Module number. |
| 675 | + * @apiBody {String} [name] Name of the module. |
| 676 | + * @apiBody {String} [outcome] Module outcome. |
| 677 | + * @apiBody {String[]} [contents] Array of contents of the module. |
| 678 | + * @apiBody {Number} [hrsPerModule] Number of hours required per module. |
| 679 | + * @apiBody {String[]} [cognitiveLevels] Array of cognitive levels |
| 680 | + * of attainment as per Bloom's Taxanomy (L1-L6). |
| 681 | + * |
| 682 | + * @apiSuccess {String} res added Module |
| 683 | + * @apiError (Error 500) Error while inserting in DB |
| 684 | + */ |
| 685 | + |
| 686 | +/** |
| 687 | + * @api {delete} /module/delete/:moduleId Delete Module |
| 688 | + * @apiName DeleteModule |
| 689 | + * @apiGroup Module |
| 690 | + * |
| 691 | + * @apiParam {String} moduleId The ID of the Module document to delete. |
| 692 | + * |
| 693 | + * @apiSuccess {String} res Success message indicating the deletion. |
| 694 | + * |
| 695 | + * @apiError (Error 500) DatabaseError Error message if there was an error during the deletion. |
| 696 | + */ |
| 697 | + |
| 698 | +/** |
| 699 | + * @api {post} /module/update/:moduleId Update Module |
| 700 | + * @apiName UpdateModule |
| 701 | + * @apiGroup Module |
| 702 | + * @apiDescription Update existing module data. |
| 703 | + * |
| 704 | + * @apiBody {Number} [no] Module number. |
| 705 | + * @apiBody {String} [name] Name of the module. |
| 706 | + * @apiBody {String} [outcome] Module outcome. |
| 707 | + * @apiBody {String[]} [contents] Array of contents of the module. |
| 708 | + * @apiBody {Number} [hrsPerModule] Number of hours required per module. |
| 709 | + * @apiBody {String[]} [cognitiveLevels] Array of cognitive levels |
| 710 | + * of attainment as per Bloom's Taxanomy (L1-L6). |
| 711 | + * |
| 712 | + * @apiSuccess {String} res Module updated. |
| 713 | + * @apiError (Error 500) DatabaseError Error in updating the database. |
| 714 | + */ |
| 715 | + |
669 | 716 | //----------------------------------------------------------------------------- |
670 | 717 | // Organization |
671 | 718 | //----------------------------------------------------------------------------- |
|
0 commit comments