deleteGroup Request

Article
05/23/2014

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Deletes a contact group.

Syntax

<deleteGroup rid="7">
   <group id="1"/>
</deleteGroup>

The following sections describe attributes, parent elements, and child elements.

Attributes

Attribute	Data Type	Description
rid	string	Represents the client-assigned instance ID for this request. This is a required attribute.

Element Information

Parent Element

Element	Description
cwaRequests	Contains one or more methods that a Unified Communications AJAX API Client sends to a Communicator Web Access Server.

Child Element

Element	Occurrence	Description
group	1	A user-defined aggregation of contacts.

Remarks

This request allows the Unified Communications AJAX API Client application to delete a contact group. The contacts associated with the group are not deleted. The un-affiliated contacts are available to be added to an existing contact group.

Examples

XML example of the request

<cwaRequests xmlns="http://schemas.microsoft.com/2006/09/rtc/cwa" sid="3">
   <deleteGroup rid="5">
      <group id="1"/>
   </deleteGroup>
</cwaRequests>

XML example of the reply for successful execution of a deleteGroup Request

The asynchronous response on the data channel indicates that the execution of the request succeeded and indicate the group id of the deleted group.

<cwaEvents pollWaitTime="1000" ackId="47" sid="3">
   <requestSucceeded eid="46" rid="5" />
   <contactGroup eid="47" deltaNum="6">
      <group id="1" action="deleted" />
   </contactGroup>
</cwaEvents>

XML example of the reply for a failed execution of a deleteGroup Request

In this case, the request to delete a contact group failed because the requested group ID does not exist.

<cwaEvents pollWaitTime="1000" ackId="53" sid="3">
   <requestFailed eid="53" rid="6">
      <error code="18201" reason="Operation failed" detail="The requested operation failed.">
         <sipResponse code="400" reason="Bad request">
            <ms-diagnostics>2002;reason="Group does not exist";source="contoso.com"</ms-diagnostics>
         </sipResponse>
      </error>
   </requestFailed>
</cwaEvents>