Enrollment Endpoints ================================================= Note: Every endpoint listed in this document is managing JSON objects, so the path structure shown for nested keys is represented in a JSON-style access pattern. User - Courses Enrolled In -------------------------- Return a list of all the courses a user is currently enrolled in. HTTP Verb: ``GET`` Endpoint: ``/api/v1/views/user//courses_enrolled_in/`` Example Request (cURL):: curl -X GET -H "App-Token: [APP_TOKEN]" -H "Token: [TOKEN]" -H "Content-Type: application/json" https://.enfixlp.com/api/v1/views/user//courses_enrolled_in/ Example Response:: [ { "_id": "5330f129a64c9e20eb2732a5", "requires_enrollment": false, "display_options": { "player_launch_method": 1, "navigation_panel_width": 200, "sco_window_width": 800, "show_navigation_header": true, "sco_window_height": 600, "navigation_header_height": 40, "show_navigation_panel": true, "sco_launch_method": 2, "sco_window_size_type": 1 }, "enrolled_groups": [], "title": "Text SCO 2", "date_updated": "2014-06-29 19:46:51", "manual_ordering_index": 0, "course_type": "scorm", "enrolled_users": [], "active": false, "date_added": "2014-03-24 22:59:53", "metadata": {}, "description": "" }, { "_id": "5bf326aa2fd84e7981bbbea3", "requires_enrollment": false, "display_options": { "player_launch_method": 1, "navigation_panel_width": 200, "sco_window_width": 800, "show_navigation_header": true, "sco_window_height": 600, "navigation_header_height": 40, "player_window_width": 1000, "show_navigation_panel": true, "sco_launch_method": 1, "player_window_height": 640, "player_window_size_type": 1, "sco_window_size_type": 1 }, "enrolled_groups": [ "5a6605c87bb6b15e342c01d1" ], "title": "Multi SCO 1", "date_updated": "2018-11-19 16:13:01", "include_subgroups": [], "manual_ordering_index": 0, "course_type": "scorm", "due_exact_date": "", "enrolled_users": [], "due_type": "", "behavior": { "allow_status_change_after_status_completed": true, "allow_score_change_after_status_failed": true, "allow_score_change_after_status_completed": true, "allow_status_change_after_status_failed": true, "allow_score_change_after_status_passed": true, "scorm_sco_rollup_mode": "last", "allow_status_change_after_status_passed": true, "allow_score_to_decrease": true }, "active": true, "date_added": "2018-11-19 16:10:02", "due_days_from_enrollment": 0, "metadata": {}, "description": "." } ] User - Courses Enrolled In With Status -------------------------------------- Return a list of all the courses a user is currently enrolled in, and any high-level status/score information in the "rollup_status" block. HTTP Verb: ``GET`` Endpoint: ``/api/v1/views/user//courses_enrolled_in/`` Example Request (cURL):: curl -X GET -H "App-Token: [APP_TOKEN]" -H "Token: [TOKEN]" -H "Content-Type: application/json" https://.enfixlp.com/api/v1/views/user//courses_enrolled_in/ Example Response:: [ { "_id": "51d5d55dbd7a84058e7bf61c", "requires_enrollment": false, "display_options": { "player_launch_method": 1, "navigation_panel_width": 221, "sco_window_width": 550, "show_navigation_header": false, "sco_window_height": 551, "navigation_header_height": 51, "player_window_width": 400, "show_navigation_panel": false, "sco_launch_method": 1, "player_window_height": 300, "player_window_size_type": 1, "sco_window_size_type": 1 }, "enrolled_groups": [ "5a6605c87bb6b15e342c01af", "5a6605c87bb6b15e342c01b1", "5a6605c87bb6b15e342c01b3" ], "title": "SCO Tester", "date_updated": "2018-01-29 07:47:15", "manual_ordering_index": 200, "course_type": "scorm", "due_exact_date": "2018-01-31 00:00:00", "enrolled_users": [], "due_type": "exact_date", "behavior": { "allow_status_change_after_status_completed": true, "allow_score_change_after_status_failed": true, "allow_score_change_after_status_completed": true, "allow_status_change_after_status_failed": true, "allow_score_change_after_status_passed": true, "allow_status_change_after_status_passed": true, "allow_score_to_decrease": true }, "active": true, "date_added": "2014-03-14T19:50:48.517000", "due_days_from_enrollment": 360, "metadata": {}, "description": "Description required here.", "calculated_due_date": "2018-01-31 00:00:00", "rollup_status": { "status": "C", "score": 82.0, "date_added": "2018-07-31 23:37:04", "date_updated": "2019-11-23 08:01:46", "total_wall_time": 578865 } }, { "_id": "5145eb3abd7a844438bb931c", "requires_enrollment": false, "display_options": { "player_launch_method": 2, "navigation_panel_width": 200, "sco_window_width": 800, "show_navigation_header": false, "sco_window_height": 600, "navigation_header_height": 40, "show_navigation_panel": true, "sco_launch_method": 1, "sco_window_size_type": 1 }, "enrolled_groups": [ "51413a49bd7a841b9ca9528b", "51413a67bd7a841b9ca9528c", "51101a73bd7a841143c4cb9c", "51101c07bd7a8412229d1f31" ], "title": "Diagnostic SCO", "date_updated": "2014-07-17 11:31:09", "manual_ordering_index": 100, "course_type": "scorm", "enrolled_users": [], "active": true, "date_added": "2014-03-14 19:50:48", "metadata": {}, "description": "", "rollup_status": { "status": "N", "score": "", "date_added": "", "date_updated": "", "total_wall_time": -1 } }, { "_id": "5dea70cfe6c8349439869e42", "title": "AICC Test 1", "course_type": "aicc", "description": ".", "active": false, "requires_enrollment": false, "enrolled_groups": [], "enrolled_users": [], "include_subgroups": [], "manual_ordering_index": 0, "due_type": "", "due_exact_date": "", "due_days_from_enrollment": 0, "aicc_launch_url": "", "metadata": {}, "display_options": { "show_navigation_panel": true, "show_navigation_header": true, "navigation_header_height": 40, "navigation_panel_width": 200, "player_launch_method": 1, "sco_launch_method": 1, "sco_window_size_type": 1, "sco_window_width": 800, "sco_window_height": 600, "player_window_size_type": 1, "player_window_width": 1000, "player_window_height": 640 }, "behavior": { "allow_score_to_decrease": true, "allow_score_change_after_status_passed": true, "allow_score_change_after_status_failed": true, "allow_score_change_after_status_completed": true, "allow_status_change_after_status_passed": true, "allow_status_change_after_status_failed": true, "allow_status_change_after_status_completed": true, "scorm_sco_rollup_mode": "" }, "date_added": "2019-12-06 10:16:31", "date_updated": "2019-12-06 10:16:44", "rollup_status": { "status": "N", "score": "", "date_added": "", "date_updated": "", "total_wall_time": -1 } } ] Course - Users Enrolled In -------------------------- Return a list of all the users enrolled in a course. HTTP Verb: ``GET`` Endpoint: ``/api/v1/views/course//users_enrolled_in/`` Example Request (cURL):: curl -X GET -H "App-Token: [APP_TOKEN]" -H "Token: [TOKEN]" -H "Content-Type: application/json" https://.enfixlp.com/api/v1/views/course//users_enrolled_in/ Example Response:: [ { "_id": "51293841bd7a8494f0a3369f", "username": "test12", "name": "Test User 1", "roles": [ "557d927a40df56c7fe5a89f9" ], "date_updated": "2018-10-11 11:07:16", "date_added": "2013-03-17 23:52:26", "active": true, "_password": "...", "email": "test14@test14.com", }, { "_id": "51299265bd7a84af48bd2a51", "_password": "...", "date_added": "2013-03-17 23:52:26", "date_updated": "2013-02-23 23:09:09", "email": "test13@test13.com", "groups": [], "name": "Test User 13", "roles": [], "username": "test13" } ]