GetImItems 操作GetImItems operation

Getimitems EWS 操作についての情報を検索します。Find information about the GetImItems EWS operation.

Getimitems操作は、インスタントメッセージング (im) グループと im 連絡先のペルソナに関する情報を取得します。The GetImItems operation retrieves information about instant messaging (IM) groups and IM contact personas.

この操作は Exchange Server 2013 で導入されました。This operation was introduced in Exchange Server 2013.

GetImItems 操作の使用Using the GetImItems operation

Getimitems操作は、グループと連絡先アイテムの識別子を受け入れ、グループと連絡先に関する情報のセットを返します。The GetImItems operation accepts group and contact item identifiers and returns a set of information about the groups and contacts. 応答で返されるプロパティセットは、拡張プロパティ、複数の連絡先識別子、グループ識別子、および拡張プロパティ定義によって、引数として識別されます。The property sets returned in the response are identified by extended properties, multiple contact identifiers, group identifiers, and extended property definitions as arguments.

GetImItems 操作 SOAP ヘッダーGetImItems operation SOAP headers

Getimitems操作では、次の表に示す SOAP ヘッダーを使用できます。The GetImItems 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.
MailboxCultureMailboxCulture
MailboxCultureMailboxCulture
RFC 3066 で定義されているように、メールボックスへのアクセスに使用されるカルチャ (言語の識別用のタグ) を識別します。Identifies the culture, as defined in RFC 3066, "Tags for the Identification of Languages", to be used to access the mailbox. このヘッダーは、要求に適用されます。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.

GetImItems 操作要求の例: IM 連絡先とグループに関する詳細情報を取得します。GetImItems operation request example: Get detailed information about IM contacts and groups

次のGetimitems操作要求の例は、IM 連絡先とグループに関する詳細情報を要求する方法を示しています。The following example of a GetImItems operation request shows how to request detailed information about IM contacts and groups. Getimitems操作は、1つまたは複数の連絡先またはグループの詳細を要求できます。A GetImItems operation can request one or more contact or group details. また、拡張プロパティを使用して、グループや連絡先のカスタムプロパティを取得することもできます。You can also use extended properties to get custom properties on groups and contacts. 要求された拡張プロパティがアイテムに存在しない場合、応答は要求されたプロパティを無視し、既定のプロパティセットに対する応答を返します。If a requested extended property does not exist on an item, the response will ignore the requested property and return the response for the default property set. この例では、拡張プロパティを使用して、表示名を取得する方法を示します。This example shows you how to get the display name by using extended properties.

注意

この記事のすべてのアイテム識別子と変更キーは、読みやすくするために短縮されています。All item identifiers and change keys in this article have been shortened to preserve readability. この操作では、キーの変更は無視されることに注意してください。Note that change keys are ignored by the service for this operation.

<?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" />
      <t:MailboxCulture>en-US</t:MailboxCulture>
   </soap:Header>
   <soap:Body >
      <m:GetImItems>
         <m:ContactIds>
            <t:ItemId Id="AAMkADEzOTExYACABmEhpSAAA=" ChangeKey="EQAAABBmNDjF"/>
         </m:ContactIds>
         <m:GroupIds>
            <t:ItemId Id="AAMkADEzOTExYjJkBY7+0EAAA=" ChangeKey="EgAAAA=="/>
         </m:GroupIds>         
         <m:ExtendedProperties>
            <t:ExtendedProperty PropertyTag="0x3001" PropertyType="String"/>
         </m:ExtendedProperties>
      </m:GetImItems>
   </soap:Body>
</soap:Envelope>

要求 SOAP 本文には、次の要素が含まれています。The request SOAP body contains the following elements:

成功した GetImItems 操作の応答Successful GetImItems operation response

次の例は、IM 連絡先とグループを取得するためのGetimitems要求に対する正常な応答を示しています。The following example shows a successful response to a GetImItems request to get an IM contact and group. 表示名は、拡張プロパティで要求されます。The display name is requested in an extended property. IM 連絡先は、ペルソナの形式で返されます。IM contacts are returned in the form of a persona.

<?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="556" 
                           MinorBuildNumber="8" 
                           Version="Exchange2013" 
                           xmlns:h="https://schemas.microsoft.com/exchange/services/2006/types" 
                           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"/>
   </s:Header>
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
           xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <GetImItemsResponse ResponseClass="Success" 
                          xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
         <ResponseCode>NoError</ResponseCode>
         <ImItemList>
            <Groups xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
               <ImGroup>
                  <DisplayName>Exchange SDK Team</DisplayName>
                  <GroupType>IPM.DistList.MOC.UserGroup</GroupType>
                  <ExchangeStoreId Id="AAMkADEzQrAABY7+0EAAA=" ChangeKey="EgAAAA=="/>
                  <MemberCorrelationKey>
                     <ItemId Id="AAMkADEzOTExYjeGgGqm4QrAABmEhpSAAA=" ChangeKey="EQAAAA=="/>
                  </MemberCorrelationKey>
                  <ExtendedProperties>
                     <ExtendedProperty>
                        <ExtendedFieldURI PropertyTag="0x3001" PropertyType="String"/>
                        <Value>Exchange SDK Team</Value>
                     </ExtendedProperty>
                  </ExtendedProperties>
               </ImGroup>
            </Groups>
            <Personas xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
               <Persona>
                  <PersonaId Id="AAQkADEzOTBZImBzN5J/uHXc="/>
                  <PersonaType>Person</PersonaType>
                  <CreationTime>2012-11-07T00:10:35Z</CreationTime>
                  <DisplayName>Tony Smith</DisplayName>
                  <DisplayNameFirstLast>Tony Smith</DisplayNameFirstLast>
                  <DisplayNameLastFirst>Tony Smith</DisplayNameLastFirst>
                  <FileAs/>
                  <FileAsId>None</FileAsId>
                  <ImAddress>tsmith@contoso.com</ImAddress>
                  <RelevanceScore>2147483647</RelevanceScore>
                  <Attributions>
                     <Attribution>
                        <Id>0</Id>
                        <SourceId Id="AAMkADEzhQaoeGgGqm4QrAABmEhpSAAA=" ChangeKey="EQArAABmNDjF"/>
                        <DisplayName>Lync Contacts</DisplayName>
                        <IsWritable>false</IsWritable>
                        <IsQuickContact>true</IsQuickContact>
                        <IsHidden>false</IsHidden>
                     </Attribution>
                  </Attributions>
                  <DisplayNames>
                     <StringAttributedValue>
                        <Value>Tony Smith</Value>
                        <Attributions>
                           <Attribution>0</Attribution>
                        </Attributions>
                     </StringAttributedValue>
                  </DisplayNames>
                  <FileAsIds>
                     <StringAttributedValue>
                        <Value>None</Value>
                        <Attributions>
                           <Attribution>0</Attribution>
                        </Attributions>
                     </StringAttributedValue>
                  </FileAsIds>
                  <ImAddresses>
                     <StringAttributedValue>
                        <Value>tsmith@contoso.com</Value>
                        <Attributions>
                           <Attribution>0</Attribution>
                        </Attributions>
                     </StringAttributedValue>
                  </ImAddresses>
                  <ExtendedProperties>
                     <ExtendedPropertyAttributedValue>
                        <Value>
                           <ExtendedFieldURI PropertyTag="0x3001" PropertyType="String"/>
                           <Value>Tony Smith</Value>
                        </Value>
                        <Attributions>
                           <Attribution>0</Attribution>
                        </Attributions>
                     </ExtendedPropertyAttributedValue>
                  </ExtendedProperties>
               </Persona>
            </Personas>
         </ImItemList>
      </GetImItemsResponse>
   </s:Body>
</s:Envelope>

応答 SOAP 本文には、次の要素が含まれています。The response SOAP body contains the following elements:

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

Getimitems操作は、識別子を検証しません。無効な連絡先またはグループの識別子がサービスに指定されている場合、 ErrorInvalidImContactIdまたはErrorInvalidImGroupIdのエラー応答は返されません。The GetImItems operation does not validate identifiers and will not return the expected ErrorInvalidImContactId or ErrorInvalidImGroupId error response if an invalid contact or group identifier is provided to the service.

関連項目See also