Files
edx-platform/lms/djangoapps/program_enrollments/readme.rst
Kyle McCormick c487b9a384 Change 'withdrawn' status to 'canceled' in program_enrollments
This makes the LMS program_enrollments API compatible with the
Registrar programs API, as specified in the Master's partner
integration guide.

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

22 lines
649 B
ReStructuredText

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`