SectionService#

class SectionService[source]#

Methods

add_users

Add users to a course section.

create_division

Connect users to a course section.

get

Get a course section.

delete

Delete a course section.

patch

Update a course section.

delete_user

Remove a user from a course section.

add_users(json_body, *, section_id)[source]#

Add users to a course section.

Parameters:
Returns:

The updated course section.

Return type:

ExtendedCourseSection

create_division(json_body, *, section_id)[source]#

Connect users to a course section.

Users that are already enrolled in the course connected to this section are immediately added to the course section. Other users will be added to the section as soon as they enroll in the course.

Parameters:
Returns:

The new division containing the users that were not immediately added to the course section.

Return type:

CreateDivisionResult

get(*, section_id)[source]#

Get a course section.

Parameters:
Returns:

The requested course section.

Return type:

ExtendedCourseSection

delete(*, section_id)[source]#

Delete a course section.

Parameters:
Returns:

Nothing.

Return type:

None

patch(json_body, *, section_id)[source]#

Update a course section.

Parameters:
Returns:

The updated course section.

Return type:

ExtendedCourseSection

delete_user(*, section_id, user_id)[source]#

Remove a user from a course section.

Parameters:
  • section_id (str) – The id of the course section to remove the user from.

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

  • self (SectionService[AuthenticatedClient]) –

Returns:

The updated course section.

Return type:

ExtendedCourseSection