Group types

Retrieving group type objects

class GroupTypeMixin

This class defines all functions related to BlueConic group types.

get_group_type(group_type_id)

Gets the group type.

Parameters:

group_type_id (str) – The group type ID

Returns:

The group type

Return type:

Optional[GroupType]

get_group_types()

Gets all group types and returns them in a generator with all BlueConic group types.

Returns:

Iterator with GroupTypes

Return type:

Iterator[GroupType]

get_id_properties(idProperties)

Gets the idProperties and adds them to a list of ProfileProperty objects

Returns:

List of ProfileProperty

Return type:

List[ProfileProperty]

Using group type objects

class GroupType
property icon

Returns the SVG source of the icon of this group type.

property id

Returns the ID of this group type.

property id_properties

Returns the idProperties of this group type.

property id_property

Returns the ID of the profile property that contains the group ID that a profile is part of.

property name_plural

Returns the plural name of this group type.

property name_singular

Returns the singular name of this group type.