Enrollment¶

class canvasapi.enrollment.Enrollment(requester, attributes)¶

Parameters:	requester (`canvasapi.requester.Requester`) – The requester to pass HTTP requests through. attributes (dict) – The JSON object to build this object with.

accept(**kwargs)¶

Accept a pending course invitation.

Calls:	POST /api/v1/courses/:course_id/enrollments/:id/accept
Returns:	True if the course invitation was accepted.
Return type:	bool

deactivate(task, **kwargs)¶

Delete, conclude, or deactivate an enrollment.

The following tasks can be performed on an enrollment: conclude, delete, inactivate, deactivate.

Calls:	DELETE /api/v1/courses/:course_id/enrollments/:id
Parameters:	task (str) – The task to perform on the enrollment.
Return type:	`canvasapi.enrollment.Enrollment`

reactivate(**kwargs)¶

Activate an inactive enrollment.

Calls:	PUT /api/v1/courses/:course_id/enrollments/:id/reactivate
Return type:	`canvasapi.enrollment.Enrollment`

reject(**kwargs)¶

Reject a pending course invitation.

Calls:	POST /api/v1/courses/:course_id/enrollments/:id/reject
Returns:	True if the course invitation was rejected.
Return type:	bool