Операция FindPeopleFindPeople operation

Поиск сведений о FindPeopleной операции EWS.Find information about the FindPeople EWS operation.

Операция FindPeople возвращает все объекты персоны из указанной папки контактов или получает контакты, которые совпадают с указанной строкой запроса.The FindPeople operation returns all persona objects from a specified Contacts folder or retrieves contacts that match a specified query string.

Эта операция появилась в Exchange Server 2013.This operation was introduced in Exchange Server 2013.

Использование операции FindPeopleUsing the FindPeople operation

Операция FindPeople возвращает объединенные сведения о контакте.The FindPeople operation returns aggregated contact information.

Операция FindPeople строится на существующих функциональных возможностях сложных типов restriction и басешапе , добавляя ограничение статистической обработки и возвращая возможность возврата дополнительных свойств.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". Поведение поиска по умолчанию предназначено для личного почтового ящика указанного пользователя и глобального списка адресов (GAL).The default search behavior targets both the specified user's personal mailbox and the global address list (GAL). При поиске в глобальном списке адресов в качестве основной папки поиска необходимо указать строку запроса вместо ограничения, так как эта операция не позволяет просматривать глобальный список адресов.When searching the GAL as the primary search folder, you must specify a query string instead of a restriction, because this operation does not allow for browsing of the GAL.

Заголовки SOAP операции FindPeopleFindPeople operation SOAP headers

Операция FindPeople может использовать заголовки SOAP, указанные в приведенной ниже таблице.The FindPeople operation can use the SOAP headers that are listed in the following table.

Имя заголовкаHeader name ЭлементElement ОписаниеDescription
ОлицетворениеImpersonation
ексчанжеимперсонатионExchangeImpersonation
Идентифицирует пользователя, который олицетворяет клиентское приложение.Identifies the user whom the client application is impersonating. Этот заголовок является применимым для запроса.This header is applicable to a request.
рекуестверсионRequestVersion
рекуестсерверверсионRequestServerVersion
Определяет версию схемы для запроса операции.Identifies the schema version for the operation request. Этот заголовок является применимым для запроса.This header is applicable to a request.
серверверсионServerVersion
серверверсионинфоServerVersionInfo
Определяет версию сервера, который ответил на запрос.Identifies the version of the server that responded to the request. Этот заголовок является применимым для отклика.This header is applicable to a response.

Пример запроса операции FindPeopleFindPeople operation request example

В следующем примере запроса операции FindPeople показано, как вернуть первые 100 контактов из папки "Контакты".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="https://schemas.microsoft.com/exchange/services/2006/types"
               xmlns:m="https://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>

Текст SOAP Request содержит следующие элементы:The request SOAP body contains the following elements:

В приведенном ниже примере запроса операции FindPeople показано, как возвратить первые 100 контактов из глобального списка адресов с помощью строки запроса.The following example of a FindPeople operation request shows how to return the first 100 contacts from the GAL by using a query string. Если задать для дистингуишедфолдерид значение "каталог", будет осуществляться поиск глобального источника адресов в глобальном списке адресов.Setting the DistinguishedFolderId to "directory" will search the GAL as the primary source of personas.

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types"
               xmlns:m="https://schemas.microsoft.com/exchange/services/2006/messages">
   <soap:Header>
    <t:RequestServerVersion Version="Exchange2013" />
   </soap:Header>
   <soap:Body >
    <m:FindPeople>
      <m:PersonaShape>
        <t:BaseShape>IdOnly</t:BaseShape>
        <t:AdditionalProperties>
          <t:FieldURI FieldURI="persona:DisplayName"/>
          <t:FieldURI FieldURI="persona:Title"/>
        </t:AdditionalProperties>
      </m:PersonaShape>
      <m:IndexedPageItemView BasePoint="Beginning" MaxEntriesReturned="100" Offset="0"/>
      <m:ParentFolderId>
        <t:DistinguishedFolderId Id="directory"/>
      </m:ParentFolderId>
      <m:QueryString>adams</m:QueryString>
    </m:FindPeople>
  </soap:Body>
</soap:Envelope>

Успешный отклик операции FindPeopleSuccessful FindPeople operation response

В следующем примере показан успешный ответ на запрос операции FindPeople .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="https://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="https://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="https://schemas.microsoft.com/exchange/services/2006/messages">
      <ResponseCode>NoError</ResponseCode>
      <People>
        <Persona xmlns="https://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>

Тело SOAP отклика содержит следующие элементы:The response SOAP body contains the following elements:

Ответ об ошибке операции FindPeopleFindPeople operation error response

Коды ошибок, являющиеся общими для EWS, представлены в разделе респонсекоде.For error codes that are generic to EWS, see ResponseCode.

См. такжеSee also