edx-platform

Files

Kyle McCormick af4e7a348a Create Python API for program_enrollments: Part IV

This commit completes the program_enrollments LMS app
Python API for the time being. It does the following:
* Add bulk-lookup of users by external key in api/reading.py
* Add bulk-writing of program enrollments in api/writing.py
* Move grade-reading to api/grades.py
* Refactor api/linking.py to use api/writing.py
* Refactor signals.py to use api/linking.py
* Update rest_api/v1/views.py to utilize all these changes
* Update linking management command and support tool to use API
* Remove outdated tests from test_models.py
* Misc. cleanup

EDUCATOR-4321

2019-09-20 09:55:13 -04:00

api

Create Python API for program_enrollments: Part IV

2019-09-20 09:55:13 -04:00

doc_images

Add UML diagram for the ProgramEnrollments Plugin

2019-05-21 09:28:28 -04:00

docs/decisions

Add the correct UNIQUE constraints to the ProgramEnrollment model.

2019-08-23 14:02:54 -04:00

management

Create Python API for program_enrollments: Part IV

2019-09-20 09:55:13 -04:00

migrations

Add new ProgramCourseEnrollment uniqueness constriant (#21463 )

2019-08-27 15:05:30 -04:00

rest_api

Create Python API for program_enrollments: Part IV

2019-09-20 09:55:13 -04:00

tests

Create Python API for program_enrollments: Part IV

2019-09-20 09:55:13 -04:00

__init__.py

Add ProgramEnrollment app and model for masters

2019-04-12 15:50:30 -04:00

admin.py

INCR-475: Make compatible with Python 3.x

2019-06-21 13:41:23 +03:00

apps.py

Create Python API for program_enrollments: Part I (#21511 )

2019-09-04 14:06:00 -04:00

constants.py

Create Python API for program_enrollments: Part IV

2019-09-20 09:55:13 -04:00

exceptions.py

Create Python API for program_enrollments: Part IV

2019-09-20 09:55:13 -04:00

models.py

Create Python API for program_enrollments: Part IV

2019-09-20 09:55:13 -04:00

readme.rst

Change 'withdrawn' status to 'canceled' in program_enrollments

2019-06-03 10:16:19 -04:00

signals.py

Create Python API for program_enrollments: Part IV

2019-09-20 09:55:13 -04:00

tasks.py

Create Python API for program_enrollments: Part III

2019-09-12 14:54:03 -04:00

readme.rst

Program Enrollments
======================

This is the Program Enrollments plugin that allows university partners to
enroll their students in Master's courses on the edx platform. 

.. image:: doc_images/pe_uml.png

Considerations:
    - ProgramEnrollments
        - Must have either user_id or external_user_key or both.
        -  Valid values for the `status` field:
            - `enrolled`
            - `pending`
            - `suspended`
            - `canceled`
    - ProgramCourseEnrollments
        -  Valid values for the `status` field:
            - `enrolled`
            - `pending`
            - `suspended`
            - `canceled`