API Endpoints Description API endpoint description table
description action request payload response payload response code URI /category + create a category POST {"cat_name": "", "cat_desc": "", "cat_icon_url": null}{"cat_id": , "cat_name": "", "cat_desc": "", "cat_icon_url": null, "date_created": "", "date_modified": ""}201, Created /create/retrieve category details GET {"cat_id": , "cat_name": "", "cat_desc": "", "cat_icon_url": null, "date_created": "", "date_modified": "", courses: []}200, OK /<cat_id>/get list of all the categories with details GET [{"cat_id": , "cat_name": "", "cat_desc": "", "cat_icon_url": null, "date_created": "", "date_modified": "", courses: []}, ... ...]200, OK /update a category PUT {"cat_name": "", "cat_desc": "", "cat_icon_url": null}{"cat_id": , "cat_name": "", "cat_desc": "", "cat_icon_url": null, "date_created": "", "date_modified": "", courses: []}200, OK /<cat_id>/delete a category# DELETE 204, No Content /<cat_id>/
#If there are courses associated with a category, then you can’t delete that category until you delete or dissociate all the related courses.
description action request payload response payload response code URI /courses + create a course POST {"course_name": "","course_description": "","faculty": null, "course_icon_url": null, "category":<pk> }{"cid": ,"course_name": "", "course_description": "", "faculty": null, "course_icon_url": null, "date_created": "", "date_modified": "", "lessons":[]}201, CREATED /create/retrieve course’s details GET {"cid": ,"course_name": "", "course_description": "", "faculty": null, "course_icon_url": null, "date_created": "", "date_modified": "", "lessons":[]}200, OK /<cid>/retrieve list of all courses with details GET [{"cid": ,"course_name": "", "course_description": "", "faculty": null, "course_icon_url": null, "date_created": "", "date_modified": "", "lessons":[]}, ... ...]200, OK /update a course PUT {"course_name": "","course_description": "","faculty": null, "course_icon_url": null, "category":<pk> }{"cid": ,"course_name": "", "course_description": "", "faculty": null, "course_icon_url": null, "date_created": "", "date_modified": "", "lessons":[]}200, OK /<cid>/delete a course# DELETE 204, NO CONTENT /<cid>/retrieve a list of selected courses POST {"list":[cid1, cid2, cid3]}[{---object details---}, {---object details---}, ... ...]200, OK /getbulk/
# If there are lessons associated with a course, then you can’t delete that course until you delete or dissociate all the related lessons.
description action request payload response payload response code URI /lessons + create a lesson POST {"course": null, "lesson_name": " ", "lesson_seqnum": null, "lesson_desc": " ", "lesson_icon_url": " "}{"liid": , "litem_name": " ", "litem_seqnum": , "litem_icon_url": null, "litem_asset_url": " ", "litem_desc": " ", "date_created": " ", "date_modified": " "}201 Created /create/retrieve a lesson’s details GET {"liid": , "litem_name": " ", "litem_seqnum": , "litem_icon_url": null, "litem_asset_url": " ", "litem_desc": " ", "date_created": " ", "date_modified": " "}200, OK /<lid>/retrieve list of all lessons with details of each lesson GET [{"liid": , "litem_name": " ", "litem_seqnum": , "litem_icon_url": null, "litem_asset_url": " ", "litem_desc": " ", "date_created": " ", "date_modified": " "}, {... ...},...]200, OK /update a lesson PUT {"course": null, "lesson_name": " ", "lesson_seqnum": null, "lesson_desc": " ", "lesson_icon_url": " "}{"liid": , "litem_name": " ", "litem_seqnum": , "litem_icon_url": null, "litem_asset_url": " ", "litem_desc": " ", "date_created": " ", "date_modified": " "}200, OK /<lid>/delete a lesson DELETE 204, No Content /<lid>/
description action request payload response payload response code URI /litems + create a lesson item POST {"lesson": null, "litem_name": "", "litem_seqnum": null, "litem_icon_url": "", "litem_asset_url": "", "litem_desc": ""}{"liid": , "lesson": , "litem_name": " ", "litem_seqnum": , "litem_icon_url": null, "litem_asset_url": " ", "litem_desc": " ", "date_created": " ", "date_modified": " "}201, Created /create/retrieve a lesson item’s details GET {"liid": , "lesson": , "litem_name": " ", "litem_seqnum": , "litem_icon_url": null, "litem_asset_url": " ", "litem_desc": " ", "date_created": " ", "date_modified": " "}200, OK /<llid>/retrieve list of all lessons items with detail of each lesson item GET [{"liid": , "lesson": , "litem_name": " ", "litem_seqnum": , "litem_icon_url": null, "litem_asset_url": " ", "litem_desc": " ", "date_created": " ", "date_modified": " "}, {... ...}, ...]200, OK /update a lesson item PUT {"lesson": null, "litem_name": "", "litem_seqnum": null, "litem_icon_url": "", "litem_asset_url": "", "litem_desc": ""}{"liid": , "lesson": , "litem_name": " ", "litem_seqnum": , "litem_icon_url": null, "litem_asset_url": " ", "litem_desc": " ", "date_created": " ", "date_modified": " "}200, OK /<llid>/delete a lesson item DELETE 204, No Content /<llid>/