Operação FindPeopleFindPeople operation

Encontre informações sobre a operação do EWS do FindPeople .Find information about the FindPeople EWS operation.

A operação FindPeople retorna todos os objetos persona de uma pasta de contatos especificada ou recupera contatos que correspondem a uma cadeia de caracteres de consulta especificada.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.This operation was introduced in Exchange Server 2013.

Usando a operação FindPeopleUsing the FindPeople operation

A operação FindPeople retorna informações de contato agregadas.The FindPeople operation returns aggregated contact information.

A operação FindPeople cria a funcionalidade existente dos tipos complexos Restriction e BaseShape adicionando uma restrição de agregação e a capacidade de retornar propriedades adicionais.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. Usando uma restrição, um cliente pode especificar filtros, como "somente resultados de retorno que têm um endereço de mensagens instantâneas".By using a restriction, a client can specify filters such as "only return results that have an IM address". O comportamento de pesquisa padrão é direcionado para a caixa de correio pessoal e a lista de endereços global (GAL) do usuário especificado.The default search behavior targets both the specified user's personal mailbox and the global address list (GAL). Ao pesquisar a GAL como a pasta de pesquisa principal, você deve especificar uma cadeia de caracteres de consulta em vez de uma restrição, porque essa operação não permite a navegação da 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.

Cabeçalhos SOAP de operação FindPeopleFindPeople operation SOAP headers

A operação FindPeople pode usar os cabeçalhos SOAP listados na tabela a seguir.The FindPeople operation can use the SOAP headers that are listed in the following table.

Nome de cabeçalhoHeader name ElementoElement DescriçãoDescription
RepresentaçãoImpersonation
ExchangeImpersonationExchangeImpersonation
Identifica o usuário que o aplicativo cliente está representando.Identifies the user whom the client application is impersonating. Este cabeçalho é aplicável a uma solicitação.This header is applicable to a request.
RequestVersionRequestVersion
RequestServerVersionRequestServerVersion
Identifica a versão do esquema para a solicitação de operação.Identifies the schema version for the operation request. Este cabeçalho é aplicável a uma solicitação.This header is applicable to a request.
ServerVersionServerVersion
ServerVersionInfoServerVersionInfo
Identifica a versão do servidor que respondeu à solicitação.Identifies the version of the server that responded to the request. Este cabeçalho é aplicável a uma resposta.This header is applicable to a response.

Exemplo de solicitação de operação FindPeopleFindPeople operation request example

O exemplo a seguir de uma solicitação de operação FindPeople mostra como retornar os primeiros 100 contatos da pasta contatos.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>

O corpo SOAP de solicitação contém os seguintes elementos:The request SOAP body contains the following elements:

O exemplo a seguir de uma solicitação de operação FindPeople mostra como retornar os primeiros 100 contatos da GAL usando uma cadeia de caracteres de consulta.The following example of a FindPeople operation request shows how to return the first 100 contacts from the GAL by using a query string. A configuração do DistinguishedFolderId como "Directory" pesquisará a GAL como a principal fonte de personas.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>

Resposta de operação FindPeople bem-sucedidaSuccessful FindPeople operation response

O exemplo a seguir mostra uma resposta bem-sucedida a uma solicitação de operação 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>

O corpo SOAP de resposta contém os seguintes elementos:The response SOAP body contains the following elements:

Resposta de erro de operação FindPeopleFindPeople operation error response

Para códigos de erro genéricos para EWS, confira ResponseCode.For error codes that are generic to EWS, see ResponseCode.

Confira tambémSee also