addGroup Request

  • Article

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.

Creates a contact group.

Syntax

<addGroup rid="5">
   <group name="string value"/>
</addGroup>

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

Attributes

Attribute

Description

rid

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 Elements

Element

Occurrence

Description

group

1

A user-defined aggregator of user contacts.

Remarks

This request method allows the Unified Communications AJAX API Client application to add a contact group. This group is persisted with the Communicator Web Access Server so that the next time the client logs on to the Communicator Web Access Server, the added group displays. Duplicate contact group names are not allowed.

Examples

XML example of the request

<cwaRequests xmlns="http://schemas.microsoft.com/2006/09/rtc/cwa" sid="1">

<addGroup rid="4">

<group name="MyFriends">

</group>

</addGroup>

</cwaRequests>

XML Example of a response indicating success

<cwaEvents pollWaitTime="1000" ackId="18" sid="1">
   <requestSucceeded eid="17" rid="4" />
   <contactGroup eid="18" deltaNum="5">
      <group id="1" action="added" name="MyFriends" externalUri="" />
   </contactGroup>
</cwaEvents>

XML Example of a response indicating failure

If the request to add a contact group specifies a group name that already exists for the logged on user, the following error response returns on the data channel.

<cwaEvents pollWaitTime="1000" ackId="17" sid="3">
   <requestFailed eid="17" rid="4">
      <error code="18201" reason="Operation failed" detail="The requested operation failed.">
         <sipResponse code="485" reason="Ambiguous">
            <ms-diagnostics>2015;reason="Duplicate group name";source="contoso.com"</ms-diagnostics>
         </sipResponse>
      </error>
   </requestFailed>
</cwaEvents>