Skip to main content
Version: Current

GetGroupResponse

Represents a group returned by QueryAsync, GetAllGroupsAsync, and GetGroupByNameAsync.

Constructor​

GetGroupResponse() initializes a group response object. Applications normally read objects returned by the group APIs.

Properties​

PropertyTypeDescription
GroupIdintUnique identifier of the group.
TenantIdintIdentifier of the tenant to which the group belongs.
ParentIdint?Identifier of the parent group, if assigned.
CalendarIdint?Identifier of the associated business calendar, if assigned.
CalendarNamestringName of the associated business calendar. Initialized to an empty string.
NamestringGroup name.
DescriptionstringGroup description.
LeaderIdint?Identifier of the group leader, if assigned.
IsEnabledboolWhether the group is enabled. Initialized to true on a new model instance.
CreatedDateTimeDate and time when the group was created.
ModifiedDateTimeDate and time when the group was last modified.
CreatedBystringUser who created the group.
ModifiedBystringUser who last modified the group.
RolesIEnumerable<ViewGroupRole>Group role assignments. Initialized to an empty collection.

Nullable integer properties can contain null. Initialization values describe newly constructed model instances; response values reflect server data. The task specification does not define a time zone for the date/time values.

ViewGroupRole​

Represents a role assignment on a group.

PropertyTypeDescription
GroupRoleIdintUnique identifier of the group role assignment.
GroupIdint?Identifier of the group, if present.
RoleIdint?Identifier of the role, if present.