Bulk enroll

Bulk enroll

POST https://your-platform-url.com/api/bulk_enroll/v1/bulk_enroll/

Cet endpoint permet d'inscrire ou désinscrire un apprenants à un ou plusieurs cours. Permissions : Être administrateur du cours pour lequel vous souhaitez inscrire les utilisateurs.

Headers

{    "name": "Cake's name",    "recipe": "Cake's recipe name",    "cake": "Binary cake"}

Bulk enrollment

Inscrire un ou plusieurs utilisateurs dans un ou plusieurs cours.

Request example

POST /api/bulk_enroll/v1/bulk_enroll/ {
            "auto_enroll": true,
            "email_students": true,
            "action": "enroll",
            "courses": "course-v1:edX+Demo+123,course-v1:edX+Demo2+456",
            "cohorts": "cohortA,cohortA",
            "identifiers": "brandon@example.com,yamilah@example.com"
        }

POST Parameters

Response Values

If the supplied course data is valid and the enrollments were successful, an HTTP 200 "OK" response is returned. The HTTP 200 response body contains a list of response data for each enrollment. If a cohorts list is provided, additional 'cohort' keys will be added to the 'before' and 'after' states.

{
    "action": "unenroll",
    "courses": {
        "course-v1:edX+DemoX+Demo_Course": {
            "action": "unenroll",
            "results": [
                {
                    "identifier": "test-email@example.com",
                    "after": {
                        "enrollment": true,
                        "allowed": false,
                        "user": true,
                        "auto_enroll": false
                    },
                    "before": {
                        "enrollment": false,
                        "allowed": false,
                        "user": true,
                        "auto_enroll": false
                    }
                }
            ],
            "auto_enroll": true
        }
    },
    "email_students": false,
    "auto_enroll": true
}

Dernière mise à jour