Opération FindPeople

Article
03/29/2023

Recherchez des informations sur l’opération FindPeople EWS.

L’opération FindPeople renvoie tous les objets persona d’un dossier Contacts spécifié ou récupère les contacts qui correspondent à une chaîne de requête spécifiée.

Cette opération est une nouveauté d’Exchange Server 2013.

Utilisation de l’opération FindPeople

L’opération FindPeople retourne des informations de contact agrégées.

L’opération FindPeople s’appuie sur les fonctionnalités existantes des types complexes Restriction et BaseShape en ajoutant une restriction d’agrégation et la possibilité de retourner des propriétés supplémentaires. En utilisant une restriction, un client peut spécifier des filtres tels que « renvoyer uniquement les résultats qui ont une adresse de messagerie instantanée ». 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 (GAL). Lorsque vous recherchez la liste d’adresses gal 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 n’autorise pas la navigation dans la liste d’adresses.

En-têtes SOAP de l’opération FindPeople

L’opération FindPeople peut utiliser les en-têtes SOAP répertoriés dans le tableau suivant.

Nom de l'en-tête	Élément	Description
Imitation	ExchangeImpersonation	Identifie l’utilisateur que l’application cliente emprunte l’identité. Cet en-tête s’applique à une requête.
RequestVersion	RequestServerVersion	Identifie la version du schéma pour la demande d’opération. Cet en-tête s’applique à une requête.
ServerVersion	ServerVersionInfo	Identifie la version du serveur qui a répondu à la requête. Cet en-tête s’applique à une réponse.

Exemple de demande d’opération FindPeople

L’exemple suivant de demande d’opération FindPeople montre comment retourner les 100 premiers contacts à partir du dossier Contacts.

<?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 :

L’exemple suivant de demande d’opération FindPeople montre comment retourner les 100 premiers contacts à partir de la liste d’adresses globale à l’aide d’une chaîne de requête. Si vous définissez DistinguishedFolderId sur « directory », vous recherchez la liste d’adresses gal comme source principale des personnages.

<?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éussie

L’exemple suivant montre une réponse réussie à une demande d’opération FindPeople .

<?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 la réponse contient les éléments suivants :

Réponse d’erreur de l’opération FindPeople

Pour les codes d’erreur génériques pour EWS, consultez ResponseCode.