GroupService

class GroupService

Methods

add_member	Add a user (member) to a group.
get	Get a group by id.
delete	Delete a group by id.
remove_member	Remove a member from a group.
rename_group	Update the name of the group.

add_member(json_body, *, group_id, extra_parameters=None)

Add a user (member) to a group.

Parameters:

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

• group_id (int) – The id of the group the user should be added 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 (GroupService[AuthenticatedClient]) –

Returns:

The group with the newly added user.

Return type:

ExtendedGroup

get(*, group_id, extra_parameters=None)

Get a group by id.

Parameters:

• group_id (int) – The id of the group 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 (GroupService[AuthenticatedClient]) –

Returns:

The requested group.

Return type:

ExtendedGroup

delete(*, group_id, extra_parameters=None)

Delete a group by id.

This action is irreversible!

This is only possible if the group doesn’t have any submissions associated with it.

Parameters:

• group_id (int) – The id of the group 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 (GroupService[AuthenticatedClient]) –

Returns:

Nothing.

Return type:

None

remove_member(*, group_id, user_id, extra_parameters=None)

Remove a member from a group.

If the group has a submission you cannot delete the last remaining member of a group.

Parameters:

• group_id (int) – The group the user should be removed from.

• user_id (int) – The user that should be removed.

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

Returns:

The group without the removed user.

Return type:

ExtendedGroup

rename_group(json_body, *, group_id, extra_parameters=None)

Update the name of the group.

Parameters:

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

• group_id (int) – The id of the group that should be updated.

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

Returns:

The group with the updated name.

Return type:

ExtendedGroup