1. Home / Web Services API Version 8.x / DeleteUsergroup

DeleteUsergroup

Deletes the specified user group.

Syntax

Visual Basic (declaration) 
Public Function DeleteUsergroup( _ 
	ByVal AuthenticationTicket as String, _ 
	ByVal DomainName as String, _ 
	ByVal GroupName as String) as XmlNode

C# (declaration) 
public XmlNode DeleteUsergroup( 
	string AuthenticationTicket,
	string DomainName,
	string GroupName)

Parameters

AuthenticationTicket
    string infoRouter ticket
DomainName
    string The Domain name if the user group is local.
GroupName
    string The user group name to be deleted

Return Value

returns xml fragment.
<response success="true" error="">
if success = "true", the user group has been deleted.
if success = "false", the error returns the error description.

Remarks

The caller must be the system administrator or the domain manager of the specified domain.


minus gif Example

Visual Basic Example 
Public Sub DeleteUsergroup()
        Const IRAuthenticationTicket As String = "sid-xxxxxxxxxxxxx"
        Const IR_DomainName As String = "Knowledge Base"
        Const IR_UserGroup As String = "Authors"
 
        Dim IR_Obj As InfoRouter.srv
        Dim xmlResponse As System.Xml.XmlElement
        Try
 
            IR_Obj = New InfoRouter.srv
            xmlResponse = IR_Obj.DeleteUsergroup(IRAuthenticationTicket, _
                                                 IR_DomainName, _
                                                 IR_UserGroup)
            If xmlResponse.GetAttribute("success") = "true" Then
                Console.WriteLine("The usergroup deleted successfully.")
            Else
                Console.WriteLine("The usergroup cannot be deleted.")
                Console.WriteLine("server response:" & xmlResponse.GetAttribute("error"))
            End If
            xmlResponse = Nothing
 
        Catch ex As Exception
            Console.WriteLine("error:" & ex.Message)
        Finally
            IR_Obj = Nothing
        End Try
   End Sub

See Also