FindPeople operation
Published: July 16, 2012
Find information about the FindPeople EWS operation.
Applies to: Exchange 2013 | Exchange Online
The FindPeople operation returns all persona objects from a specified Contacts folder or retrieves contacts that match a specified query string.
This operation was introduced in Exchange Server 2013.
The FindPeople operation returns aggregated contact information.
The FindPeople operation builds on the existing functionality of the Restriction and BaseShape complex types by adding an aggregation restriction and the ability to return additional properties. By using a restriction, a client can specify filters such as "only return results that have an IM address". The default search behavior targets both the specified user's personal mailbox and the global address list (GAL).
FindPeople operation SOAP headers
The FindPeople operation can use the SOAP headers that are listed in the following table.
Header name | Element | Description |
|---|---|---|
Impersonation | Identifies the user whom the client application is impersonating. This header is applicable to a request. | |
RequestVersion | Identifies the schema version for the operation request. This header is applicable to a request. | |
ServerVersion | Identifies the version of the server that responded to the request. This header is applicable to a response. |
The following example of a FindPeople operation request shows how to return the first 100 contacts from the Contacts folder.
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages">
<soap:Header>
<t:RequestServerVersion Version="Exchange2013" />
</soap:Header>
<soap:Body >
<m:FindPeople>
<m:IndexedPageItemView BasePoint="Beginning" MaxEntriesReturned="100" Offset="0"/>
<m:ParentFolderId>
<t:DistinguishedFolderId Id="contacts"/>
</m:ParentFolderId>
</m:FindPeople>
</soap:Body>
</soap:Envelope>
The request SOAP body contains the following elements:
The following example shows a successful response to a FindPeople operation request.
<?xml version="1.0" encoding="utf-8"?><s:Envelope
xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="15"
MinorVersion="0"
MajorBuildNumber="349"
MinorBuildNumber="0"
Version="Exchange2013"
xmlns="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types" />
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<FindPeopleResponse ResponseClass="Success"
xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<ResponseCode>NoError</ResponseCode>
<People>
<Persona xmlns="http://schemas.microsoft.com/exchange/services/2006/types">
<PersonaId Id="AAQkAGQ1MjJjMTBkLTc4Y2UtNDA5Ny04ZjU5LWI3MTYzNGNkZmRkYQAQAOjFqObcLmtOlzlRnHdXQjo=" />
<CreationTime>2012-01-11T22:25:37Z</CreationTime>
<DisplayName>Terry Adams</DisplayName>
<DisplayNameFirstLast>Terry Adams</DisplayNameFirstLast>
<DisplayNameLastFirst>Adams Terry</DisplayNameLastFirst>
<FileAs>Adams, Terry</FileAs>
<GivenName>Terry</GivenName>
<Surname>Adams</Surname>
<EmailAddress>
<Name>terry@litwareinc.com</Name>
<EmailAddress>terry@litwareinc.com</EmailAddress>
<RoutingType>SMTP</RoutingType>
</EmailAddress>
<EmailAddresses>
<EmailAddress>
<Name>terry@litwareinc.com</Name>
<EmailAddress>terry@litwareinc.com</EmailAddress>
<RoutingType>SMTP</RoutingType>
</EmailAddress>
<EmailAddress>
<Name>tadams@contoso.com</Name>
<EmailAddress>tadams@contoso.com</EmailAddress>
<RoutingType>SMTP</RoutingType>
</EmailAddress>
</EmailAddresses>
<RelevanceScore>2147483647</RelevanceScore>
</Persona>
</People>
<TotalNumberOfPeopleInView>1</TotalNumberOfPeopleInView>
</FindPeopleResponse>
</s:Body>
</s:Envelope>
The response SOAP body contains the following elements:
For error codes that are generic to EWS, see ResponseCode.
Date | Description |
|---|---|
July 16, 2012 | Initial publication |
