API Endpoints

post
Bulk enroll

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.
Request
Response
Request
Headers
Access-Control-Request-Headers
optional
string
authorization
Authorization
required
string
Bearer <auth_token>
Content-Type
optional
string
application/json
Response
200: OK
Cake successfully retrieved.
{ "name": "Cake's name", "recipe": "Cake's recipe name", "cake": "Binary cake"}
404: Not Found
Could not find a cake matching this query.
{ "message": "Ain't no cake like that."}

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

Key

Comments

auto_enroll

When set to true, students will be enrolled as soon as they register.

email_students

When set to true, students will be sent email notifications upon enrollment.

action

Can either be set to "enroll" or "unenroll". This determines the behavior

cohorts

Optional. If provided, the number of items in the list should be equal to the number of courses. first cohort coressponds with the first course and so on. The learners will be added to the corresponding cohort.

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
}