Merge pull request #9984 from edx/ahodges/enroll_api

Updates the description provided for a new enrollment report

common/djangoapps/enrollment/views.py

@@ -457,15 +457,18 @@ class EnrollmentListView(APIView, ApiKeyPermissionMixIn):
         """Gets a list of all course enrollments for a user.
 
         Returns a list for the currently logged in user, or for the user named by the 'user' GET
-        parameter.  If the username does not match the currently logged in user, only courses the
-        requesting user has staff permissions for are listed.
-
-        Only staff or instructor permissions on individual courses are taken into account when
-        deciding whether the requesting user is permitted to see a particular enrollment, i.e.
-        organizational staff access doesn't grant permission to see the enrollments in all courses
-        of the organization.  This may change in the future.
-
-        However, users with global staff access can see all enrollments of all students.
+        parameter. If the username does not match that of the currently logged in user, only
+        courses for which the currently logged in user has the Staff or Admin role are listed.
+        As a result, a course team member can find out which of his or her own courses a particular
+        learner is enrolled in.
+
+        Only the Staff or Admin role (granted on the Django administrative console as the staff
+        or instructor permission) in individual courses gives the requesting user access to
+        enrollment data. Permissions granted at the organizational level do not give a user
+        access to enrollment data for all of that organization's courses.
+
+        Users who have the global staff permission can access all enrollment data for all
+        courses.
         """
         username = request.GET.get('user', request.user.username)
         try:

docs/en_us/platform_api/source/conf.py

@@ -193,7 +193,8 @@ MOCK_MODULES = [
     'student.auth',
     'ccx_keys',
     'ccx_keys.locator',
-    'user_api.preferences.api'
+    'user_api.preferences.api',
+    'rest_framework_oauth.authentication'
 ]
 
 for mod_name in MOCK_MODULES:

docs/en_us/platform_api/source/enrollment/enrollment.rst

@@ -57,7 +57,7 @@ Get the User's Enrollment Status in a Course
 Get the User's Enrollment Information for a Course
 **************************************************
 
-.. .. autoclass:: enrollment.views.EnrollmentCourseDetailView
+.. autoclass:: enrollment.views.EnrollmentCourseDetailView
 
 **Example response showing a user's course enrollment information**
 
@@ -160,7 +160,7 @@ View a User's Enrollments or Enroll a User in a Course
 .. code-block:: json
 
     {
-        “course_details”: {
-            “course_id”: “edX/DemoX/Demo_Course”
+        "course_details": {
+            "course_id": "edX/DemoX/Demo_Course"
         }
     }
\ No newline at end of file

docs/en_us/platform_api/source/enrollment/overview.rst

@@ -31,20 +31,16 @@ The Enrollment API supports the following tasks, methods, and endpoints.
    * - Task
      - Method
      - Endpoint
-   * - :ref:`Get the user's enrollment status in a course 
-       <Get the Users Enrollment Status in a Course>`
+   * - :ref:`Get the user's enrollment status in a course <Get the Users Enrollment Status in a Course>`
      - GET
      - /api/enrollment/v1/enrollment/{user_id},{course_id}
-   * - :ref:`Get the user's enrollment information for a course
-       <Get Enrollment Details for a Course>`
+   * - :ref:`Get the user's enrollment information for a course <Get Enrollment Details for a Course>`
      - GET
      - /api/enrollment/v1/course/{course_id}
-   * - :ref:`View a user's enrollments 
-       <View and add to a Users Course Enrollments>`
+   * - :ref:`View a user's enrollments <View and add to a Users Course Enrollments>`
      - GET
      - /api/enrollment/v1/enrollment
-   * - :ref:`Enroll a user in a course 
-       <View and add to a Users Course Enrollments>`
+   * - :ref:`Enroll a user in a course <View and add to a Users Course Enrollments>`
      - POST
-     - /api/enrollment/v1/enrollment{“course_details”:{“course_id”:“*course_id*”}}
+     - /api/enrollment/v1/enrollment{"course_details":{"course_id":"{course_id}"}}