Opération FindPeopleFindPeople operation

Trouvez des informations sur l’opération EWS FindPeople .Find information about the FindPeople EWS operation.

L’opération FindPeople renvoie tous les objets Persona d’un dossier de contacts spécifié ou récupère les contacts qui correspondent à une chaîne de requête spécifiée.The FindPeople operation returns all persona objects from a specified Contacts folder or retrieves contacts that match a specified query string.

Cette opération est une nouveauté d’Exchange Server 2013.This operation was introduced in Exchange Server 2013.

Utilisation de l’opération FindPeopleUsing the FindPeople operation

L’opération FindPeople renvoie des informations de contact regroupées.The FindPeople operation returns aggregated contact information.

L’opération FindPeople s’appuie sur la fonctionnalité existante des types complexes de restriction et de BaseShape en ajoutant une restriction d’agrégation et la possibilité de renvoyer des propriétés supplémentaires.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. À l’aide d’une restriction, un client peut spécifier des filtres, tels que « renvoyer uniquement les résultats ayant une adresse de messagerie instantanée ».By using a restriction, a client can specify filters such as "only return results that have an IM address". Le comportement de recherche par défaut cible à la fois la boîte aux lettres personnelle de l’utilisateur spécifié et la liste d’adresses globale (LAG).The default search behavior targets both the specified user's personal mailbox and the global address list (GAL). Lors de la recherche dans la liste d’adresses globale en tant que dossier de recherche principal, vous devez spécifier une chaîne de requête au lieu d’une restriction, car cette opération ne permet pas de parcourir la liste d’adresses globale.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.

En-têtes SOAP d’opération FindPeopleFindPeople operation SOAP headers

L’opération FindPeople peut utiliser les en-têtes SOAP répertoriés dans le tableau suivant.The FindPeople operation can use the SOAP headers that are listed in the following table.

Nom de l'en-têteHeader name ÉlémentElement DescriptionDescription
Emprunt d’identitéImpersonation
ExchangeImpersonationExchangeImpersonation
Identifie l’utilisateur qui emprunte l’identité de l’application cliente.Identifies the user whom the client application is impersonating. Cet en-tête s’applique à une demande.This header is applicable to a request.
RequestVersionRequestVersion
RequestServerVersionRequestServerVersion
Identifie la version de schéma de la demande d’opération.Identifies the schema version for the operation request. Cet en-tête s’applique à une demande.This header is applicable to a request.
ServerVersionServerVersion
ServerVersionInfoServerVersionInfo
Identifie la version du serveur qui a répondu à la demande.Identifies the version of the server that responded to the request. Cet en-tête s’applique à une réponse.This header is applicable to a response.

Exemple de requête d’opération FindPeopleFindPeople operation request example

L’exemple suivant de demande d’opération FindPeople indique comment renvoyer les premiers contacts 100 à partir du dossier contacts.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>

Le corps SOAP de la demande contient les éléments suivants :The request SOAP body contains the following elements:

L’exemple suivant de demande d’opération FindPeople indique comment renvoyer les premiers contacts 100 de la liste d’adresses globale à l’aide d’une chaîne de requête.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 définition de DistinguishedFolderId sur « Directory » effectuera une recherche dans la liste d’adresses globale comme source principale de personnages.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>

Réponse de l’opération FindPeople réussieSuccessful FindPeople operation response

L’exemple suivant montre une réponse réussie à une demande d’opération 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>

Le corps SOAP de réponse contient les éléments suivants :The response SOAP body contains the following elements:

Réponse d’erreur d’opération FindPeopleFindPeople operation error response

Pour les codes d’erreur qui sont génériques à EWS, voir ResponseCode.For error codes that are generic to EWS, see ResponseCode.

Voir aussiSee also