GroupSetService

class GroupSetService

Methods

create_group	Create a group for the given group set.
get	Get a single GroupSet by id.
delete	Delete a GroupSet.
get_all_groups	Get all groups for a given group set.

create_group(json_body, *, group_set_id, extra_parameters=None)

Create a group for the given group set.

Parameters:

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

• group_set_id (int) – The id of the group set where the new group should be placed 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 (GroupSetService[AuthenticatedClient]) –

Returns:

The newly created group.

Return type:

ExtendedGroup

get(*, group_set_id, extra_parameters=None)

Get a single GroupSet by id.

Parameters:

• group_set_id (int) – The id of the group set

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

Returns:

A response containing the JSON serialized group set.

Return type:

GroupSet

delete(*, group_set_id, extra_parameters=None)

Delete a GroupSet.

You can only delete a group set if there are no groups in the set and no assignment is connected to the group set.

Parameters:

• group_set_id (int) – The id of the group set

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

Returns:

Nothing.

Return type:

None

get_all_groups(*, group_set_id, extra_parameters=None)

Get all groups for a given group set.

Parameters:

• group_set_id (int) – The group set for which the groups should be returned.

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

Returns:

All the groups for the given group set.

Return type:

Sequence[ExtendedGroup]