POST http://helix2:1900/api/PublicApi/SaveGroupMember
This API is used to manage user group memberships. It supports different transaction types to add, remove, or update user-group associations.
1. Add User to Group
Adds specified user (UserId) to target group (GroupId). Request must include TransactionType set to SaveGroupMember.
Example call:
POST
http://helix2:1900/api/PublicApi/SaveGroupMember
{
"UserId":
103,
"GroupId":
14,
"TransactionType": "SaveGroupMember"
}
Response Example
{
"Data":
{
"Id": 21253,
"ReferenceId": 103
},
"Errors":
null,
"IsError":
false
}
2. Remove User from Group
Removes specified user (UserId) from given group (GroupId). Request must include TransactionType set to DeleteGroupMember.
Example call:
POST
http://helix2:1900/api/PublicApi/SaveGroupMember
{
"UserId":
103,
"GroupId":
20,
"TransactionType": "DeleteGroupMember"
}
Response Example
{
"Data":
{
"Id": 21254,
"ReferenceId": 103
},
"Errors":
null,
"IsError":
false
}
3. Remove All Group Memberships for a User
Removes all group associations for specified user (UserId). Request only requires UserId and TransactionType set to RemoveAllGroupsForUser.
Example call:
POST
http://helix2:1900/api/PublicApi/SaveGroupMember
{
"UserId":
103,
"TransactionType": "RemoveAllGroupsForUser"
}
Response Example
{
"Data":
{
"Id": 21255,
"ReferenceId": 103
},
"Errors":
null,
"IsError":
false
}
4. Remove All Users from a Group
Removes all users from specified group (GroupId). Request must include TransactionType set to RemoveAllUsersFromGroup.
Example call:
POST
http://helix2:1900/api/PublicApi/SaveGroupMember
{
"GroupId":
9,
"TransactionType": "RemoveAllUsersFromGroup"
}
Response Example
{
"Data":
{
"Id": 21256,
"ReferenceId": 9
},
"Errors":
null,
"IsError":
false
}