searchResult Element

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.

Returns a query result: zero (0) or more users.

Syntax

<searchResult eid="integer value" rid="string value" returned = "integer value" moreAvailable="true"|"false" returned="integer value"/>

Attributes

Attribute	Data Type	Description
eid	integer	Event Id. This is an integer value assigned by the Communicator Web Access Server.
returned	integer	The number of users returned in the searchResult.
rid	string	Request Id. This is a string value assigned by the Unified Communications client. This is a required attribute.
moreAvailable	Boolean	There are more results of the search to be returned.
returned	integer	Indicates how many results were returned in a result set.

Element Information

Parent Element

Element	Description
cwaEvents	Holds the responses from the asynchronous data channel with which a Unified Communications AJAX API Client polls the server for updates that have taken place.

Child Elements

Element	Occurrences	Description
user	1 or more	Holds the result of the search request. The attribute values of the user element are the user presence values.

Remarks

The user elements of the searchResult set do not contain presence information. A client must send a queryPresence request for the resulting users to receive their presence data.

Examples

The client requests a search and the results of the search are returned asynchronously. White was space added to XML snippet for clarity.

<searchResult eid="134" rid="20" returned="1" moreAvailable="true" returned="10">
   <user
       uri="jessicaa@contoso.com"
       displayName="Jessica Arnold"
       title="Vice President"
       office="Main"
       phone="405 555-1212"
       homePhone="405 555-1213"
       cellPhone="405 555-1214"
       otherPhone="405 555-1215"
       company="Contoso"
       city="Redmond"
       state="WA"
       country="USA"
       email="jessicaa@contoso.com"
   </user>
</searchResult>

To receive the presence of the returned user, the client sends the queryPresence request method with the uri attribute of the user element returned above.

<queryPresence rid="21">
   <uris>
      <uri>sip:jessicaa@contoso.com</uri>
   </uris>
</queryPresence>