addMember 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.

Adds a set of users to a pre-defined presence level container.

Syntax

<addMember type="uri" value="sip:jessicaa@contoso.com"/>

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

Attributes

Attribute	Data Type	Description
type	string	The type of URI. This can be one of uri \| everyone \| domain \| sameEnterprise \| publicCloud \| federated. This is a required attribute.
value	xs:anyUri	The URI indicated the Access Control Entry (ACE). This is a required attribute.

Enumerations of type attribute

Possible Value	Description
uri	A single user.
everyone	The most general category. This assigns all user contacts to the container containing the addMember element.
domain	All users from this domain are assigned as members of the parent container element.
sameEnterprise	All users in the same enterprise (company) are assigned to the parent container element.
publicCloud	Users of other IM systems complying to the industry standard that allows other IM systems to inter-operate with Communicator Web Access.
federated	Users from federated companies.

Element Information

Parent Element

Element	Description
container	This multi-use element can be used to request the addition or removal of contacts from a given presence-level access container. The range of acceptable values is 1 - 32767.

Remarks

The addMember element specifies the user or group of users to be added to the parent container. The type attribute determines the size of the user group to be added.

The request could fail with following error.

Error Condition	Code
Too many members in a container.	413 Request Entity Too Large
Too many total members across all containers.	413 Request Entity Too Large

Examples

XML example of the request

<container id="400" version="1">
   <addMember type="uri" value="sip:joea@contoso.com" />
</container>

Share via