diff --git a/lms/djangoapps/program_enrollments/doc_images/pe_uml.png b/lms/djangoapps/program_enrollments/doc_images/pe_uml.png new file mode 100644 index 0000000000..ca47b11473 Binary files /dev/null and b/lms/djangoapps/program_enrollments/doc_images/pe_uml.png differ diff --git a/lms/djangoapps/program_enrollments/readme.rst b/lms/djangoapps/program_enrollments/readme.rst new file mode 100644 index 0000000000..8c89bf8e5a --- /dev/null +++ b/lms/djangoapps/program_enrollments/readme.rst @@ -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` \ No newline at end of file