Operación FindPeopleFindPeople operation

Buscar información sobre la operación de EWS de FindPeople .Find information about the FindPeople EWS operation.

La operación FindPeople devuelve todos los objetos de rol de una carpeta de contactos especificada o recupera contactos que coinciden con una cadena de consulta especificada.The FindPeople operation returns all persona objects from a specified Contacts folder or retrieves contacts that match a specified query string.

Esta operación se introdujo en Exchange Server 2013.This operation was introduced in Exchange Server 2013.

Uso de la operación FindPeopleUsing the FindPeople operation

La operación FindPeople devuelve información de contacto agregada.The FindPeople operation returns aggregated contact information.

La operación FindPeople se basa en la funcionalidad existente de los tipos complejos Restriction y BaseShape agregando una restricción de agregación y la capacidad de devolver propiedades adicionales.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. Mediante el uso de una restricción, un cliente puede especificar filtros como "devolver solo los resultados que tienen una dirección de mensajería instantánea".By using a restriction, a client can specify filters such as "only return results that have an IM address". El comportamiento de búsqueda predeterminado tiene como objetivo el buzón personal del usuario especificado y la lista global de direcciones (GAL).The default search behavior targets both the specified user's personal mailbox and the global address list (GAL). Al buscar la GAL como carpeta de búsqueda principal, debe especificar una cadena de consulta en lugar de una restricción, ya que esta operación no permite examinar la 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.

Encabezados SOAP de operación FindPeopleFindPeople operation SOAP headers

La operación FindPeople puede usar los encabezados SOAP que se enumeran en la tabla siguiente.The FindPeople operation can use the SOAP headers that are listed in the following table.

Nombre de encabezadoHeader name ElementoElement DescripciónDescription
SuplantaciónImpersonation
ExchangeImpersonationExchangeImpersonation
Identifica al usuario que está suplantando la aplicación cliente.Identifies the user whom the client application is impersonating. Este encabezado se aplica a una solicitud.This header is applicable to a request.
RequestVersionRequestVersion
RequestServerVersionRequestServerVersion
Identifica la versión del esquema para la solicitud de operación.Identifies the schema version for the operation request. Este encabezado se aplica a una solicitud.This header is applicable to a request.
ServerVersionServerVersion
ServerVersionInfoServerVersionInfo
Identifica la versión del servidor que respondió a la solicitud.Identifies the version of the server that responded to the request. Este encabezado se aplica a una respuesta.This header is applicable to a response.

Ejemplo de solicitud de operación FindPeopleFindPeople operation request example

El siguiente ejemplo de una solicitud de operación de FindPeople muestra cómo devolver los primeros 100 contactos de la carpeta de contactos.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>

El cuerpo SOAP de la solicitud contiene los siguientes elementos:The request SOAP body contains the following elements:

El siguiente ejemplo de una solicitud de operación de FindPeople muestra cómo devolver los primeros 100 contactos de la GAL mediante una cadena 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. La configuración de DistinguishedFolderId en "Directory" buscará en la GAL como el origen principal de roles.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>

Respuesta de operación FindPeople correctaSuccessful FindPeople operation response

En el ejemplo siguiente se muestra una respuesta correcta a una solicitud de operación de 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>

El cuerpo SOAP de respuesta contiene los siguientes elementos:The response SOAP body contains the following elements:

Respuesta de error de operación de FindPeopleFindPeople operation error response

Para los códigos de error que son genéricos para EWS, vea ResponseCode.For error codes that are generic to EWS, see ResponseCode.

Vea tambiénSee also