TimePunch User Group Service
UserGroupDto
This class defines a group of users such as team, department or branch. Each group has group leader and zero to n assistants.
| Datatype | Name | Description |
|---|---|---|
| String | GroupName | Unique Name of the Group (unique in combination with the group type) |
| GroupType | GroupType | Defines the type of the group (e.g. Team, Department or Branch) |
| UserProfileDto | GroupLeader | Leader of the defined group |
| List \<UserGroupMemberDto> | GroupMembers | Group Members |
UserGroupMemberDto : UserGrouSaveMemberDto
This class contains the data from loading group members. The class is derived from the UserGroupSaveMemberDto class.
| Datatype | Name | Description |
|---|---|---|
| String | GroupName | Name of the group where the member belongs to. |
UserGrouSaveMemberDto
This class contains all data that is necessary to save group members. The class is derived from the UserProfileDto class.
| Datatype | Name | Description |
|---|---|---|
| Guid? | GroupId | Id of the group to that the user belongs |
| GroupType | GroupType | Type of the group to that the group belongs. |
| GroupMemberType | MemberType | Defines the type of the group member (e.g. Member or Assistant) |
| Bool | IsDeleted | True, if the user shall removed from the group |
| Bool | IsPrimaryGroup | True, if the group is the primary group for the user (eg. Primary group is used for holiday requests) |
UserGroupSearchDto : PagingContextDto
This class offers properties to search for user groups. This class is derived from the PagingContextDto.
| Datatype | Name | Description |
|---|---|---|
| String | GroupName | Name of the user group to search for. |
| GroupType | GroupType | Type of the user group to search for (or undefined to search all group types) |
| Bool | EnrichWithMembers | True, if the group members shall be included within the result. |
UserGroupDto
Diese Klasse definiert eine Benutzergruppe wie Team, Abteilung oder Niederlassung. Jede Gruppe hat dabei einen Gruppenleiter und 0 bis n Assistenten.
| Datatype | Name | Description |
|---|---|---|
| String | GroupName | Unique Name of the Group (unique in combination with the group type) |
| GroupType | GroupType | Defines the type of the group (e.g. Team, Department or Branch) |
| UserProfileDto | GroupLeader | Leader of the defined group |
| List\<UserGroupMemberDto\> | GroupMembers | Group Members |
UserGroupMemberDto : UserGrouSaveMemberDto
Diese Klasse enthält alle Daten die beim Laden von Gruppenmitgliedern gefüllt sind. Die Klasse ist abgeleitet von der UserGroupSaveMemberDto Klasse.
| Datatype | Name | Description |
|---|---|---|
| String | GroupName | Name of the group where the member belongs to. |
UserGroupSaveMemberDto
Diese Klasse enthält alle Daten die beim Speichern eines Gruppenmitglieds benötigt werden. Sie ist abgeleitet von der UserProfileDto Klasse.
| Datatype | Name | Description |
|---|---|---|
| Guid? | GroupId | Id of the group to that the user belongs |
| GroupType | GroupType | Type of the group to that the group belongs. |
| GroupMemberType | MemberType | Defines the type of the group member (e.g. Member or Assistant) |
| Bool | IsDeleted | True, if the user shall removed from the group |
| Bool | IsPrimaryGroup | True, if the group is the primary group for the user (eg. Primary group is used for holiday requests) |
UserGroupSearchDto : PagingContextDto
Die Klasse enthält die Eigenschaften mit denen die Gruppen gesucht werden. Die Klasse ist vom PagingContextDto abgeleitet.
| Datatype | Name | Description |
|---|---|---|
| String | GroupName | Name of the user group to search for. |
| GroupType | GroupType | Type of the user group to search for (or undefined to search all group types) |
| Bool | EnrichWithMembers | True, if the group members shall be included within the result. |