CourseService

class CourseService

Methods

get_all	Return all Course objects the current user is a member of.
create	Create a new course.
get_course_roles	Get a list of all course roles in a given course.
create_role	Add a new CourseRole to the given Course.
bulk_enroll	Bulk enroll users into this course.
create_snippet	Add or modify a CourseSnippet by key.
get_group_sets	Get the all the group sets of a given course.
create_group_set	Create or update a GroupSet in the given course id.
get_assignments	Get all assignments of the given course.
create_assignment	Create a new course for the given assignment.
get_all_enroll_links	Get the registration links for the given course.
put_enroll_link	Create or edit an enroll link.
get_sections	Get all sections of this course.
create_section	Create a new course section.
put_price	Update the price of the given course.
delete_price	Update the price of the given course.
delete_snippet	Delete the CourseSnippet with the given id.
patch_snippet	Modify the CourseSnippet with the given id.
get_registration_link	Get a registration link.
delete_enroll_link	Delete the given registration link.
delete_role	Remove a CourseRole from the given Course.
patch_role	Update the Permission of a given CourseRole in the given Course.
delete_user	Delete a user from a course.
export_gradebook	Export a gradebook as CSV for this course.
get_all_users	Get all users and their role in a course.
change_user_role	Set the CourseRole of a user in the given course.
get	Get a course by id.
patch	Update the given course with new values.
get_snippets	Get all snippets of the given course.
get_statistics	Get user statistics of a specific course.
get_permissions	Get all the permissions of the currently logged in user in this course.
get_submissions_by_user	Get all submissions by the given user in this course.
import_into	Copy a course into another course.
join_as_logged_in_user	Join a course as the currently logged in user using a registration link.
register_user_with_link	Register as a new user, and directly enroll in a course.
email_users	Sent the authors in this course an email.

get_all(*, extended=True, offset=Nothing, limit=Nothing, lti_course_id=Nothing, extra_parameters=None)

Return all Course objects the current user is a member of.

Parameters:

• extended (bool) – Whether to return extended course models or not.

• offset (Union[Just[int], _Nothing[int]]) – The index of the first course to be returned.

• limit (Union[Just[int], _Nothing[int]]) – The maximum amount of courses to return.

• lti_course_id (Union[Just[str], _Nothing[str]]) – The id of the course according to the lti platform.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

A response containing the JSON serialized courses

Return type:

Sequence[ExtendedCourse] | Sequence[Course]

create(json_body, *, extra_parameters=None)

Create a new course.

Parameters:

• json_body (Union[dict, list, CreateCourseData]) – The body of the request. See CreateCourseData for information about the possible fields. You can provide this data as a CreateCourseData or as a dictionary.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

A response containing the JSON serialization of the new course

Return type:

ExtendedCourse

get_course_roles(*, course_id, with_roles=False, extra_parameters=None)

Get a list of all course roles in a given course.

Parameters:

• course_id (int) – The id of the course to get the roles for.

• with_roles (bool) – Should a permission map be added to each role.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

An array of all course roles for the given course.

Return type:

Sequence[CourseRoleAsJSONWithPerms] | Sequence[CourseRole]

create_role(json_body, *, course_id, extra_parameters=None)

Add a new CourseRole to the given Course.

Parameters:

• json_body (Union[dict, list, CreateRoleCourseData]) – The body of the request. See CreateRoleCourseData for information about the possible fields. You can provide this data as a CreateRoleCourseData or as a dictionary.

• course_id (int) – The id of the course

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

An empty response with return code 204.

Return type:

None

bulk_enroll(json_body, *, course_id, extra_parameters=None)

Bulk enroll users into this course.

All given users are directly enrolled into the course, and they will receive an email confirming that they have been enrolled.

Users that do not exist yet are created, but no password is set yet so they cannot log in. Their course enrollment email will include a link to a page where they can set their password.

Parameters:

• json_body (Union[dict, list, BulkEnrollCourseData]) – The body of the request. See BulkEnrollCourseData for information about the possible fields. You can provide this data as a BulkEnrollCourseData or as a dictionary.

• course_id (int) – The id of the course in which users should be enrolled.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

A dictionary containing the job sending out the mails, a list of newly created users, and a list of users that could not be created because of SSO incompatibility.

Return type:

CourseBulkEnrollResult

create_snippet(json_body, *, course_id, extra_parameters=None)

Add or modify a CourseSnippet by key.

Parameters:

• json_body (Union[dict, list, CreateSnippetCourseData]) – The body of the request. See CreateSnippetCourseData for information about the possible fields. You can provide this data as a CreateSnippetCourseData or as a dictionary.

• course_id (int) – The id of the course in which you want to create a new snippet.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

A response containing the JSON serialized snippet and return code 201.

Return type:

CourseSnippet

get_group_sets(*, course_id, extra_parameters=None)

Get the all the group sets of a given course.

Parameters:

• course_id (int) – The id of the course of which the group sets should be retrieved.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

A list of group sets.

Return type:

Sequence[GroupSet]

create_group_set(json_body, *, course_id, extra_parameters=None)

Create or update a GroupSet in the given course id.

Parameters:

• json_body (Union[dict, list, CreateGroupSetCourseData]) – The body of the request. See CreateGroupSetCourseData for information about the possible fields. You can provide this data as a CreateGroupSetCourseData or as a dictionary.

• course_id (int) – The id of the course in which the group set should be created or updated. The course id of a group set cannot change.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

The created or updated group.

Return type:

GroupSet

get_assignments(*, course_id, has_rubric=Nothing, has_auto_test=Nothing, has_handin_requirements=Nothing, extra_parameters=None)

Get all assignments of the given course.

The returned assignments are sorted by deadline.

Parameters:

• course_id (int) – The id of the course

• has_rubric (Union[Just[bool], _Nothing[bool]]) – Get only assignments that have a rubric.

• has_auto_test (Union[Just[bool], _Nothing[bool]]) – Get only assignments that have a AutoTest configuration.

• has_handin_requirements (Union[Just[bool], _Nothing[bool]]) – Get only assignments that have hand-in requirements.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

A response containing the assignments of the given course sorted by deadline of the assignment

Return type:

Sequence[Assignment]

create_assignment(json_body, *, course_id, extra_parameters=None)

Create a new course for the given assignment.

Parameters:

• json_body (Union[dict, list, CreateAssignmentCourseData]) – The body of the request. See CreateAssignmentCourseData for information about the possible fields. You can provide this data as a CreateAssignmentCourseData or as a dictionary.

• course_id (int) – The course to create an assignment in.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

The newly created assignment.

Return type:

Assignment

get_all_enroll_links(*, course_id, extra_parameters=None)

Get the registration links for the given course.

Parameters:

• course_id (int) – The course id for which to get the registration links.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

An array of registration links.

Return type:

Sequence[CourseRegistrationLink]

put_enroll_link(json_body, *, course_id, extra_parameters=None)

Create or edit an enroll link.

Parameters:

• json_body (Union[dict, list, PutEnrollLinkCourseData]) – The body of the request. See PutEnrollLinkCourseData for information about the possible fields. You can provide this data as a PutEnrollLinkCourseData or as a dictionary.

• course_id (int) – The id of the course in which this link should enroll users.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

The created or edited link.

Return type:

CourseRegistrationLink

get_sections(*, course_id, extra_parameters=None)

Get all sections of this course.

Parameters:

• course_id (int) – The id of the course to get the sections for.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

A list of all sections connected to this course.

Return type:

Sequence[CourseSection]

create_section(json_body, *, course_id, extra_parameters=None)

Create a new course section.

Parameters:

• json_body (Union[dict, list, CreateSectionCourseData]) – The body of the request. See CreateSectionCourseData for information about the possible fields. You can provide this data as a CreateSectionCourseData or as a dictionary.

• course_id (int) – The id of the course to create a section for.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

The new section.

Return type:

CourseSection

put_price(json_body, *, course_id, extra_parameters=None)

Update the price of the given course.

Parameters:

• json_body (Union[dict, list, PutPriceCourseData]) – The body of the request. See PutPriceCourseData for information about the possible fields. You can provide this data as a PutPriceCourseData or as a dictionary.

• course_id (int) – The id of the course for which you want to update the price.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

The created or updated price.

Return type:

CoursePrice

delete_price(*, course_id, extra_parameters=None)

Update the price of the given course.

Parameters:

• course_id (int) – The id of the course for which you want to update the price.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

The created or updated price.

Return type:

None

delete_snippet(*, course_id, snippet_id, extra_parameters=None)

Delete the CourseSnippet with the given id.

Parameters:

• course_id (int) – The id of the course in which the snippet is located.

• snippet_id (int) – The id of the snippet

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

An empty response with return code 204

Return type:

None

patch_snippet(json_body, *, course_id, snippet_id, extra_parameters=None)

Modify the CourseSnippet with the given id.

Parameters:

• json_body (Union[dict, list, PatchSnippetCourseData]) – The body of the request. See PatchSnippetCourseData for information about the possible fields. You can provide this data as a PatchSnippetCourseData or as a dictionary.

• course_id (int) – The id of the course in which the course snippet is saved.

• snippet_id (int) – The id of the snippet to change.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

An empty response with return code 204.

Return type:

None

get_registration_link(*, course_id, link_id, extra_parameters=None)

Get a registration link.

This route can be used without logging in, i.e. you don’t have to be enrolled in the course to use this route. This route will not work for expired registration links.

Parameters:

• course_id (int) – The id of the course to which the registration link is connected.

• link_id (str) – The id of the registration link.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

Returns:

The specified registration link.

Return type:

ExtendedCourseRegistrationLink

delete_enroll_link(*, course_id, link_id, extra_parameters=None)

Delete the given registration link.

Parameters:

• course_id (int) – The id of the course to which the registration link is connected.

• link_id (str) – The id of the registration link.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

Nothing.

Return type:

None

delete_role(*, course_id, role_id, extra_parameters=None)

Remove a CourseRole from the given Course.

Parameters:

• course_id (int) – The id of the course

• role_id (int) – The id of the role you want to delete

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

An empty response with return code 204

Return type:

None

patch_role(json_body, *, course_id, role_id, extra_parameters=None)

Update the Permission of a given CourseRole in the given Course.

Parameters:

• json_body (Union[dict, list, PatchRoleCourseData]) – The body of the request. See PatchRoleCourseData for information about the possible fields. You can provide this data as a PatchRoleCourseData or as a dictionary.

• course_id (int) – The id of the course.

• role_id (int) – The id of the course role.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

An empty response with return code 204.

Return type:

None

delete_user(*, course_id, user_id, extra_parameters=None)

Delete a user from a course.

This does not delete the user’s submissions within the course.

Parameters:

• course_id (int) – The id of the course to remove the user from.

• user_id (int) – The id of the user to remove from the course.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

Nothing.

Return type:

None

export_gradebook(*, course_id, format='csv', extra_parameters=None)

Export a gradebook as CSV for this course.

Parameters:

• course_id (int) – The id of the course to export.

• format (Literal['csv', 'json']) – The format of the output file. Either “csv” or “json”.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

The task that creates the export.

Return type:

Job

get_all_users(*, course_id, q=Nothing, extra_parameters=None)

Get all users and their role in a course.

Parameters:

• course_id (int) – The id of the course

• q (Union[Just[str], _Nothing[str]]) – Only retrieve users whose name or username matches this value. This will change the output to a list of users.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

All users in this course and their role. If you provided the q parameter only the user is returned, not their role.

Return type:

Sequence[User] | Sequence[UserCourse]

change_user_role(json_body, *, course_id, extra_parameters=None)

Set the CourseRole of a user in the given course.

Parameters:

• json_body (Union[dict, list, ChangeUserRoleCourseData_1, ChangeUserRoleCourseData_1_2]) – The body of the request. See ChangeUserRoleCourseData for information about the possible fields. You can provide this data as a ChangeUserRoleCourseData or as a dictionary.

• course_id (int) – The id of the course in which you want to enroll a new user, or change the role of an existing user.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

The response will contain the JSON serialized user and course role.

Return type:

UserCourse

get(*, course_id, extra_parameters=None)

Get a course by id.

Parameters:

• course_id (int) – The id of the course

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

A response containing the JSON serialized course

Return type:

ExtendedCourse

patch(json_body, *, course_id, extra_parameters=None)

Update the given course with new values.

Parameters:

• json_body (Union[dict, list, PatchCourseData]) – The body of the request. See PatchCourseData for information about the possible fields. You can provide this data as a PatchCourseData or as a dictionary.

• course_id (int) – The id of the course you want to update.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

The updated course, in extended format.

Return type:

ExtendedCourse

get_snippets(*, course_id, extra_parameters=None)

Get all snippets of the given course.

Parameters:

• course_id (int) – The id of the course from which you want to get the snippets.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

An array containing all snippets for the given course.

Return type:

Sequence[CourseSnippet]

get_statistics(*, course_id, extra_parameters=None)

Get user statistics of a specific course.

Parameters:

• course_id (int) – The id of the course for which you want to get the statistics

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

A response containing the course management statistics

Return type:

CourseStatisticsAsJSON

get_permissions(*, course_id, extra_parameters=None)

Get all the permissions of the currently logged in user in this course.

This will return the permission as if you have already paid, even if this is not the case. We will also not check any restrictions of the current session.

Parameters:

• course_id (int) – The id of the course of which the permissions should be retrieved.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

A mapping between the permission name and a boolean indicating if the currently logged in user has this permission.

Return type:

CoursePermMap

get_submissions_by_user(*, course_id, user_id, latest_only=False, extra_parameters=None)

Get all submissions by the given user in this course.

Parameters:

• course_id (int) – The id of the course from which you want to get the submissions.

• user_id (int) – The id of the user of which you want to get the submissions.

• latest_only (bool) – Only get the latest submission of a user. Please use this option if at all possible, as students have a tendency to submit many attempts and that can make this route quite slow.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

A mapping between assignment id and the submissions done in that assignment by the given user. If the latest_only query parameter was used the value will still be an array of submissions, but the length will always be one. If the user didn’t submit for an assignment the value might be empty or the id of the assignment will be missing from the returned object.

Return type:

Mapping[str, Sequence[ExtendedWork]]

import_into(json_body, *, into_course_id, extra_parameters=None)

Copy a course into another course.

Parameters:

• json_body (Union[dict, list, ImportIntoCourseData]) – The body of the request. See ImportIntoCourseData for information about the possible fields. You can provide this data as a ImportIntoCourseData or as a dictionary.

• into_course_id (int) – The course you want to import into.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

The updated course, so the course of which the id was passed in the url.

Return type:

ExtendedCourse

join_as_logged_in_user(*, course_id, link_id, extra_parameters=None)

Join a course as the currently logged in user using a registration link.

Parameters:

• course_id (int) – The id of the course in which you want to enroll.

• link_id (str) – The id of the link you want to use to enroll.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

Nothing.

Return type:

None

register_user_with_link(json_body, *, course_id, link_id, extra_parameters=None)

Register as a new user, and directly enroll in a course.

Parameters:

• json_body (Union[dict, list, RegisterUserWithLinkCourseData]) – The body of the request. See RegisterUserWithLinkCourseData for information about the possible fields. You can provide this data as a RegisterUserWithLinkCourseData or as a dictionary.

• course_id (int) – The id of the course to which the registration link is connected.

• link_id (str) – The id of the registration link.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

Returns:

The access token that the created user can use to log in.

Return type:

UserLoginResponse

email_users(json_body, *, course_id, extra_parameters=None)

Sent the authors in this course an email.

Parameters:

• json_body (Union[dict, list, EmailUsersCourseData_1, EmailUsersCourseData_1_2]) – The body of the request. See EmailUsersCourseData for information about the possible fields. You can provide this data as a EmailUsersCourseData or as a dictionary.

• course_id (int) – The id of the course in which you want to send the emails.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (CourseService[AuthenticatedClient]) –

Returns:

A task result that will send these emails.

Return type:

Job