SectionService

class SectionService

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, extra_parameters=None)

Add users to a course section.

Parameters:

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

• section_id (str) – The id of the course section to add a user to.

• 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 (SectionService[AuthenticatedClient]) –

Returns:

The updated course section.

Return type:

ExtendedCourseSection

create_division(json_body, *, section_id, extra_parameters=None)

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:

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

• section_id (str) – The id of the course section to connect users to.

• 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 (SectionService[AuthenticatedClient]) –

Returns:

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

Return type:

ResultDataPostSectionCreateDivision

get(*, section_id, extra_parameters=None)

Get a course section.

Parameters:

• section_id (str) – The id of the course section to get.

• 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 (SectionService[AuthenticatedClient]) –

Returns:

The requested course section.

Return type:

ExtendedCourseSection

delete(*, section_id, extra_parameters=None)

Delete a course section.

Parameters:

• section_id (str) – The id of the section 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 (SectionService[AuthenticatedClient]) –

Returns:

Nothing.

Return type:

None

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

Update a course section.

Parameters:

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

• section_id (str) – The id of the course section 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 (SectionService[AuthenticatedClient]) –

Returns:

The updated course section.

Return type:

ExtendedCourseSection

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

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.

• 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 (SectionService[AuthenticatedClient]) –

Returns:

The updated course section.

Return type:

ExtendedCourseSection