Platform API Documentation

2015-03-11 10:49:20 -04:00
parent 2b5a854fd9
commit b78f25c8d1
27 changed files with 1161 additions and 388 deletions
--- a/docs/en_us/platform_api/source/enrollment/endpoints.rst
+++ b/docs/en_us/platform_api/source/enrollment/endpoints.rst
@@ -0,0 +1,26 @@
+.. _edX Enrollment API Endpoints:
+
+################################################
+Enrollment API Endpoints
+################################################
+
+You use the Enrollment API to view information about users and
+their course enrollments, course information, and videos and transcripts.
+
+The following tasks and endpoints are currently supported. 
+
+
+.. list-table::
+   :widths: 10 70
+   :header-rows: 1
+
+   * - To:
+     - Use this endpoint:
+   * - :ref:`Get the user's enrollment status in a course <Get the Users Enrollment Status in a Course>`
+     - /api/enrollment/v1/enrollment/{user_id},{course_id}
+   * - :ref:`Get enrollment details for a course<Get Enrollment Details for a Course>`
+     - /api/enrollment/v1/course/{course_id}
+   * - :ref:`View a user's enrollments <View and add to a Users Course Enrollments>`
+     - /api/enrollment/v1/enrollment
+   * - :ref:`Enroll a user in a course <View and add to a Users Course Enrollments>`
+     - /api/enrollment/v1/enrollment{“course_details”:{“course_id”:“*course_id*”}}
--- a/docs/en_us/platform_api/source/enrollment/enrollment.rst
+++ b/docs/en_us/platform_api/source/enrollment/enrollment.rst
@@ -0,0 +1,167 @@
+##################################################
+Enrollment API Module
+##################################################
+
+This page contains information on using the Enrollment API to complete
+these actions:
+
+* :ref:`Get the user's enrollment status in a course <Get the Users Enrollment Status in a Course>`
+* :ref:`Get enrollment details for a course<Get Enrollment Details for a Course>`
+* :ref:`View a user's enrollments <View and add to a Users Course Enrollments>`
+* :ref:`Enroll a user in a course <View and add to a Users Course Enrollments>`
+  
+
+.. _Get the Users Enrollment Status in a Course:
+
+********************************************
+Get the User's Enrollment Status in a Course
+********************************************
+
+.. autoclass:: enrollment.views.EnrollmentView
+
+**Example response showing the user's enrollment status in a course**
+
+.. code-block:: json
+
+    HTTP 200 OK
+    Content-Type: application/json
+    Vary: Accept
+    Allow: GET, HEAD, OPTIONS
+
+    {
+        "created": "2014-11-19T04:06:55Z", 
+        "mode": "honor", 
+        "is_active": true, 
+        "course_details": {
+            "course_id": "edX/DemoX/Demo_Course", 
+            "enrollment_end": null, 
+            "course_modes": [
+                {
+                    "slug": "honor", 
+                    "name": "Honor Code Certificate", 
+                    "min_price": 0, 
+                    "suggested_prices": [], 
+                    "currency": "usd", 
+                    "expiration_datetime": null, 
+                    "description": null
+                }
+            ], 
+            "enrollment_start": null, 
+            "invite_only": false
+        }, 
+        "user": "staff"
+    }
+
+.. _Get Enrollment Details for a Course:
+
+************************************
+Get Enrollment Details for a Course
+************************************
+
+.. autoclass:: enrollment.views.EnrollmentCourseDetailView
+
+**Example response showing a user's course enrollments**
+
+.. code-block:: json
+
+    HTTP 200 OK
+    Content-Type: application/json
+    Vary: Accept
+    Allow: GET, HEAD, OPTIONS
+
+    {
+        "course_id": "edX/DemoX/Demo_Course", 
+        "enrollment_end": null, 
+        "course_modes": [
+            {
+                "slug": "honor", 
+                "name": "Honor Code Certificate", 
+                "min_price": 0, 
+                "suggested_prices": [], 
+                "currency": "usd", 
+                "expiration_datetime": null, 
+                "description": null
+            }
+        ], 
+        "enrollment_start": null, 
+        "invite_only": false
+    }
+
+
+.. _View and add to a Users Course Enrollments:
+
+*********************************************
+View and Add to a User's Course Enrollments
+*********************************************
+
+.. autoclass:: enrollment.views.EnrollmentListView
+
+
+**Example response showing a user's course enrollments**
+
+.. code-block:: json
+
+    HTTP 200 OK
+    Content-Type: application/json
+    Vary: Accept
+    Allow: GET, POST, HEAD, OPTIONS
+
+    [
+        {
+            "created": "2014-09-19T18:08:37Z", 
+            "mode": "honor", 
+            "is_active": true, 
+            "course_details": {
+                "course_id": "edX/DemoX/Demo_Course", 
+                "enrollment_end": null, 
+                "course_modes": [
+                    {
+                        "slug": "honor", 
+                        "name": "Honor Code Certificate", 
+                        "min_price": 0, 
+                        "suggested_prices": [], 
+                        "currency": "usd", 
+                        "expiration_datetime": null, 
+                        "description": null
+                    }
+                ], 
+                "enrollment_start": null, 
+                "invite_only": false
+            }, 
+            "user": "honor"
+        }, 
+        {
+            "created": "2014-09-19T18:09:35Z", 
+            "mode": "honor", 
+            "is_active": true, 
+            "course_details": {
+                "course_id": "ArbisoftX/BulkyEmail101/2014-15", 
+                "enrollment_end": null, 
+                "course_modes": [
+                    {
+                        "slug": "honor", 
+                        "name": "Honor Code Certificate", 
+                        "min_price": 0, 
+                        "suggested_prices": [], 
+                        "currency": "usd", 
+                        "expiration_datetime": null, 
+                        "description": null
+                    }
+                ], 
+                "enrollment_start": "2014-05-01T04:00:00Z", 
+                "invite_only": false
+            }, 
+            "user": "honor"
+        }
+    ]
+
+
+**Example post request to enroll the user in a new course**
+
+.. code-block:: json
+
+    {
+        “course_details”: {
+            “course_id”: “edX/DemoX/Demo_Course”
+        }
+    }
--- a/docs/en_us/platform_api/source/enrollment/index.rst
+++ b/docs/en_us/platform_api/source/enrollment/index.rst
@@ -0,0 +1,12 @@
+.. _edX Platform Enrollment API Version 1.0:
+
+########################################
+Enrollment API Version 1.0
+########################################
+
+.. toctree::
+    :maxdepth: 2
+    
+    overview
+    endpoints
+    enrollment
--- a/docs/en_us/platform_api/source/enrollment/overview.rst
+++ b/docs/en_us/platform_api/source/enrollment/overview.rst
@@ -0,0 +1,34 @@
+.. _edX Enrollment API Overview:
+
+################################################
+Enrollment API Overview
+################################################
+
+Use the Enrollment API to view user and course enrollment
+information, and to enroll a user in a course.
+
+You can use the Enrollment API for web, desktop, and mobile
+applications.
+
+****************************************
+Enrollment API Version 1.0
+****************************************
+
+The Enrollment API is currently at version 1.0. We plan on making
+significant enhancements to this API.
+
+********************************************
+Enrollment API Capabilities
+********************************************
+
+With the Enrollment API, you can complete these tasks.
+
+* :ref:`Get the user's enrollment status in a course <Get the Users Enrollment
+  Status in a Course>`
+
+* :ref:`Get enrollment details for a course<Get Enrollment Details for a
+  Course>`
+
+* :ref:`View a user's enrollments <View and add to a Users Course Enrollments>`
+
+* :ref:`Enroll a user in a course <View and add to a Users Course Enrollments>`