Updates the description provided for a new enrollment report

https://github.com/edx/edx-platform/pull/9345
This commit is contained in:
Alison Hodges
2015-09-30 13:48:23 -04:00
parent d9a21d72fc
commit adffb10cbe
4 changed files with 20 additions and 20 deletions

View File

@@ -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:

View File

@@ -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"
}
}

View File

@@ -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}"}}