GroupController.RemoveMemberFromGroups Method |
Removes a member from a series of groups.
Namespace:
Dundas.BI.WebApi.Controllers
Assembly:
Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (25.2.0.1000)
Syntax[HttpPostAttribute("RemoveMemberFromGroups/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(404)]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(440)]
public ActionResult<OperationResultData> RemoveMemberFromGroups(
Guid id,
[FromBodyAttribute] ModifyGroupOptions options,
Guid? sessionId = null
)
<HttpPostAttribute("RemoveMemberFromGroups/{id}")>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(404)>
<ProducesResponseTypeAttribute(405)>
<ProducesResponseTypeAttribute(440)>
Public Function RemoveMemberFromGroups (
id As Guid,
<FromBodyAttribute> options As ModifyGroupOptions,
Optional sessionId As Guid? = Nothing
) As ActionResult(Of OperationResultData)
public:
[HttpPostAttribute(L"RemoveMemberFromGroups/{id}")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(404)]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(440)]
ActionResult<OperationResultData^>^ RemoveMemberFromGroups(
Guid id,
[FromBodyAttribute] ModifyGroupOptions^ options,
Nullable<Guid> sessionId = nullptr
)
[<HttpPostAttribute("RemoveMemberFromGroups/{id}")>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(404)>]
[<ProducesResponseTypeAttribute(405)>]
[<ProducesResponseTypeAttribute(440)>]
member RemoveMemberFromGroups :
id : Guid *
[<FromBodyAttribute>] options : ModifyGroupOptions *
?sessionId : Nullable<Guid>
(* Defaults:
let _sessionId = defaultArg sessionId null
*)
-> ActionResult<OperationResultData>
Parameters
- id
- Type: System.Guid
The ID of the account/group to remove. - options
- Type: Dundas.BI.WebApi.Models.ModifyGroupOptions
The list of ID's to be removed from the group. - sessionId (Optional)
- Type: System.Nullable<Guid>
Current session ID.
Return Value
Type:
ActionResult<OperationResultData>The operation completed successfully. The payload contains a
OperationResultData object.
See Also