FindPeople 操作FindPeople operation

Findpeople EWS 操作に関する情報を検索します。Find information about the FindPeople EWS operation.

Findpeople操作は、指定された連絡先フォルダーからすべての persona オブジェクトを取得するか、指定されたクエリ文字列と一致する連絡先を取得します。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.

FindPeople 操作の使用Using the FindPeople operation

Findpeople操作は集計された連絡先情報を返します。The FindPeople operation returns aggregated contact information.

Findpeople操作は、集約制限を追加し、追加のプロパティを返す機能を追加することによって、 Restrictionおよびbaseshape複合型の既存の機能に基づいて構築されます。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. 制限を使用することにより、クライアントは "IM アドレスを持つ結果のみを返す" などのフィルターを指定できます。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). GAL をプライマリ検索フォルダーとして検索する場合は、この操作では 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.

FindPeople 操作 SOAP ヘッダーFindPeople 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
ExchangeImpersonationExchangeImpersonation
クライアントアプリケーションが偽装しているユーザーを識別します。Identifies the user whom the client application is impersonating. このヘッダーは、要求に適用されます。This header is applicable to a request.
RequestVersionRequestVersion
RequestServerVersionRequestServerVersion
操作要求のスキーマバージョンを識別します。Identifies the schema version for the operation request. このヘッダーは、要求に適用されます。This header is applicable to a request.
ServerVersionServerVersion
ServerVersionInfoServerVersionInfo
要求に応答したサーバーのバージョンを識別します。Identifies the version of the server that responded to the request. このヘッダーは応答に適用されます。This header is applicable to a response.

FindPeople 操作の要求の例FindPeople 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 本文には、次の要素が含まれています。The request SOAP body contains the following elements:

Findpeople操作要求の次の例は、クエリ文字列を使用して GAL から最初の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. DistinguishedFolderIdを "directory" に設定すると、GAL がペルソナのプライマリソースとして検索されます。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>

成功した FindPeople 操作の応答Successful 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:

FindPeople 操作エラー応答FindPeople operation error response

EWS に汎用のエラーコードについては、「応答」を参照してください。For error codes that are generic to EWS, see ResponseCode.

関連項目See also