Methods
Create
Adds accessing user to a given group role
Usage
#set($groupRoleResponse = $core_v2_groupRoleMember.Create($groupId, $roleId, "%{GroupMembershipType = $groupMembershipTypeArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| groupId | int | Group Id | Required | | |
| roleId | int | Role Id | Required | | |
| GroupMembershipType | string | Group Membership Type | Optional | Member | EffectiveMember, Manager, Member, None, Owner, PendingMember |
Return Type
GroupRole
Delete
Removes accessing user from a given group role
Usage
#set($additionalInfoResponse = $core_v2_groupRoleMember.Delete($groupId, "%{RoleId = $roleIdArg, Rolename = $rolenameArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| groupId | int | Group Id | Required | | |
| RoleId | int | Either RoleId or Rolename is required | Optional | | |
| Rolename | string | Either RoleId or Rolename is required | Optional | | |
Return Type
AdditionalInfo
Get
Gets a group role membership for the accessing user
Usage
#set($groupRoleResponse = $core_v2_groupRoleMember.Get($groupId, "%{RoleId = $roleIdArg, Rolename = $rolenameArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| groupId | int | Group Id | Required | | |
| RoleId | int | Either RoleId or Rolename is required | Optional | | |
| Rolename | string | Either RoleId or Rolename is required | Optional | | |
Return Type
GroupRole
List
Lists group role members
Usage
#set($pagedListResponse = $core_v2_groupRoleMember.List($groupId, "%{MembershipType = $membershipTypeArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| groupId | int | Group Id | Required | | |
| MembershipType | string | Used to filter the results to just members of the type specified | Optional | | Manager, Member, Owner, PendingMember |
| PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
| PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
| SortBy | string | Sort By | Optional | GroupName | GroupName, GroupSortOrder, MembershipType, RoleAddedDate, RoleName |
| SortOrder | string | Sort Order | Optional | Ascending | Ascending, Descending |
Return Type
PagedList<GroupRole>