Merge pull request #20658 from edx/rir/readme

Add UML diagram for the ProgramEnrollments Plugin
This commit is contained in:
Richard I Reilly
2019-05-23 09:49:35 -04:00
committed by GitHub
2 changed files with 22 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

View File

@@ -0,0 +1,22 @@
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`
- `withdrawn`
- ProgramCourseEnrollments
- Valid values for the `status` field:
- `enrolled`
- `pending`
- `suspended`
- `withdrawn`