GetUserAvailability 操作GetUserAvailability operation

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

Getuseravailability操作は、指定された期間内のユーザー、部屋、およびリソースのセットの利用可能性に関する詳細な情報を提供します。The GetUserAvailability operation provides detailed information about the availability of a set of users, rooms, and resources within a specified time period.

GetUserAvailability 操作の使用Using the GetUserAvailability operation

Getuseravailability操作は、現在のユーザーの空き時間情報を指定された詳細レベルで提供します。The GetUserAvailability operation provides current user availability information at a specified level of detail. Outlook、Outlook Web Access、Outlook Mobile Access などのクライアントアプリケーションと、SMTP アドレスを使用して要求されたユーザー情報を識別します。Client applications such as Outlook, Outlook Web Access, Outlook Mobile Access, and others use SMTP addresses to identify the requested user information.

可用性サービスは、配布リスト内のメールボックスの数が100未満である限り、リストの各メンバーの空き時間情報を取得するように配布リストを拡張します。これは、 Getuseravailability操作が要求できる id の最大数です。The Availability service expands distribution lists to retrieve the free/busy status for each member of the list, as long as the number of mailboxes in the distribution list is less than 100, which is the maximum number of identities that the GetUserAvailability operation can request. 配布リストのメンバーの空き時間状態は、配布リスト全体で1つの空き時間状態に統合されます。The free/busy statuses of the members of the distribution list are merged into a single free/busy status for the whole distribution list.

クライアントアプリケーションの要求可用性クエリの期間を指定します。Client application requests specify the time period of the availability query. 要求された情報の既定の期間は42日です。The default time period for the requested information is 42 days. ユーザーの予定表に、クエリの定義された期間の内部と外部の両方の予定または会議が含まれている場合は、その予定が返されます。If the user's calendar contains appointments or meetings that are both within and outside the defined time period for the query, the appointment is returned.

返される予定と会議の時刻は、会議を要求しているクライアントアプリケーションと同じタイムゾーンにあります。The appointment and meeting times that are returned are in the same time zone as the client application that is requesting the meeting.

可用性サービスは、各クライアントの要求を処理します。The Availability service processes the request for each client. このサービスは、すべての定期的な予定を展開し、要求元のクライアントが受信するアクセス許可を持つ予定表の詳細の最大数を返します。The service expands all the recurring appointments and returns the maximum number of calendar details that the requesting client has permission to receive.

注意

ターゲットメールボックスが使用できない場合、または見つからない場合は、 MailRecipientNotFoundException例外がスローされます。If the target mailbox is unavailable or cannot be found, a MailRecipientNotFoundException exception is thrown. クライアントは、Active Directory ディレクトリサービスまたは Active Directory ドメインサービス (AD DS) 内にメール受信者が見つからないことを示すエラーメッセージを受信します。The client receives an error message that states that the mail recipient is not found in the Active Directory directory service or Active Directory Domain Services (AD DS).

GetUserAvailability operation SOAP ヘッダーGetUserAvailability operation SOAP headers

Getuseravailability操作では、次の表に記載されている SOAP ヘッダーを使用できます。The GetUserAvailability operation can use the SOAP headers that are listed in the following table.

HeaderHeader 要素Element 説明Description
偽装Impersonation
ExchangeImpersonationExchangeImpersonation
クライアントが偽装しているユーザーを識別します。Identifies the user whom the client 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.
TimeZoneContextTimeZoneContext
TimeZoneContextTimeZoneContext
サーバーからのすべての応答に使用するタイムゾーンを識別する SOAP ヘッダーを指定します。Specifies a SOAP header that identifies the time zone to be used for all responses from the server. サーバーから返されたすべての時間は、指定されたタイムゾーンに変換されます。All times that are returned from the server will be converted to the specified time zone. このヘッダーは応答に適用されます。This header is applicable to a response.

GetUserAvailability 要求の例: 可用性に関する情報を取得します。GetUserAvailability request example: Get availability information

次のgetuseravailability operation 要求の例は、太平洋標準時のタイムゾーンで2人のユーザーの詳細な可用性情報を取得する方法を示しています。The following example of a GetUserAvailability operation request shows how to get detailed availability information for two users in the Pacific Time time zone.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types">
  <soap:Body>
    <GetUserAvailabilityRequest xmlns="https://schemas.microsoft.com/exchange/services/2006/messages"
                xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types">
      <t:TimeZone xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
        <Bias>480</Bias>
        <StandardTime>
          <Bias>0</Bias>
          <Time>02:00:00</Time>
          <DayOrder>5</DayOrder>
          <Month>10</Month>
          <DayOfWeek>Sunday</DayOfWeek>
        </StandardTime>
        <DaylightTime>
          <Bias>-60</Bias>
          <Time>02:00:00</Time>
          <DayOrder>1</DayOrder>
          <Month>4</Month>
          <DayOfWeek>Sunday</DayOfWeek>
        </DaylightTime>
      </t:TimeZone>
      <MailboxDataArray>
        <t:MailboxData>
          <t:Email>
            <t:Address>user1@example.com</t:Address>
          </t:Email>
          <t:AttendeeType>Required</t:AttendeeType>
          <t:ExcludeConflicts>false</t:ExcludeConflicts>
        </t:MailboxData>
        <t:MailboxData>
          <t:Email>
            <t:Address>user2@example.com</t:Address>
          </t:Email>
          <t:AttendeeType>Required</t:AttendeeType>
          <t:ExcludeConflicts>false</t:ExcludeConflicts>
        </t:MailboxData>
      </MailboxDataArray>
      <t:FreeBusyViewOptions>
        <t:TimeWindow>
          <t:StartTime>2006-10-16T00:00:00</t:StartTime>
          <t:EndTime>2006-10-16T23:59:59</t:EndTime>
        </t:TimeWindow>
        <t:MergedFreeBusyIntervalInMinutes>60</t:MergedFreeBusyIntervalInMinutes>
        <t:RequestedView>DetailedMerged</t:RequestedView>
      </t:FreeBusyViewOptions>
    </GetUserAvailabilityRequest>
  </soap:Body>
</soap:Envelope>

SuggestionsViewOptions要素を使用して提案された会議を取得する方法の詳細については、EWS 仮想ディレクトリのスキーマを参照してください。For more information about retrieving suggested meetings by using the SuggestionsViewOptions element, see the schema in the EWS virtual directory.

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

正常な GetUserAvailability 操作の応答Successful GetUserAvailability operation response

次の例は、 Getuseravailability操作要求に対する正常な応答を示しています。The following example shows a successful response to the GetUserAvailability operation request.

注意

読みやすくするために、予定表イベント識別子が短縮されています。The calendar event identifiers have been shortened to preserve readability.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Header>
    <t:ServerVersionInfo MajorVersion="8" MinorVersion="0" MajorBuildNumber="665" MinorBuildNumber="7" 
                         xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types" />
  </soap:Header>
  <soap:Body>
    <GetUserAvailabilityResponse xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
      <FreeBusyResponseArray>
        <FreeBusyResponse>
          <ResponseMessage ResponseClass="Success">
            <ResponseCode>NoError</ResponseCode>
          </ResponseMessage>
          <FreeBusyView>
            <FreeBusyViewType xmlns="https://schemas.microsoft.com/exchange/services/2006/types">DetailedMerged</FreeBusyViewType>
            <MergedFreeBusy xmlns="https://schemas.microsoft.com/exchange/services/2006/types">000002220220000000000000</MergedFreeBusy>
            <CalendarEventArray xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
              <CalendarEvent>
                <StartTime>2006-10-16T06:00:00-07:00</StartTime>
                <EndTime>2006-10-16T06:30:00-07:00</EndTime>
                <BusyType>Busy</BusyType>
                <CalendarEventDetails>
                  <ID>14B6414B0</ID>
                  <Subject>Meet with Contoso Account Executives</Subject>
                  <Location />
                  <IsMeeting>false</IsMeeting>
                  <IsRecurring>false</IsRecurring>
                  <IsException>false</IsException>
                  <IsReminderSet>false</IsReminderSet>
                  <IsPrivate>false</IsPrivate>
                </CalendarEventDetails>
              </CalendarEvent>
              <CalendarEvent>
                <StartTime>2006-10-16T07:00:00-07:00</StartTime>
                <EndTime>2006-10-16T08:00:00-07:00</EndTime>
                <BusyType>Busy</BusyType>
                <CalendarEventDetails>
                  <ID>E14B6414B0B</ID>
                  <Subject>Pick up my groceries</Subject>
                  <Location />
                  <IsMeeting>false</IsMeeting>
                  <IsRecurring>false</IsRecurring>
                  <IsException>false</IsException>
                  <IsReminderSet>false</IsReminderSet>
                  <IsPrivate>false</IsPrivate>
                </CalendarEventDetails>
              </CalendarEvent>
              <CalendarEvent>
                <StartTime>2006-10-16T09:40:00-07:00</StartTime>
                <EndTime>2006-10-16T10:10:00-07:00</EndTime>
                <BusyType>Busy</BusyType>
                <CalendarEventDetails>
                  <ID>14B6414B0B1</ID>
                  <Subject>Meet with doctor</Subject>
                  <Location>Kirkland</Location>
                  <IsMeeting>false</IsMeeting>
                  <IsRecurring>false</IsRecurring>
                  <IsException>false</IsException>
                  <IsReminderSet>false</IsReminderSet>
                  <IsPrivate>false</IsPrivate>
                </CalendarEventDetails>
              </CalendarEvent>
            </CalendarEventArray>
            <WorkingHours xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
              <TimeZone>
                <Bias>480</Bias>
                <StandardTime>
                  <Bias>0</Bias>
                  <Time>02:00:00</Time>
                  <DayOrder>5</DayOrder>
                  <Month>10</Month>
                  <DayOfWeek>Sunday</DayOfWeek>
                </StandardTime>
                <DaylightTime>
                  <Bias>-60</Bias>
                  <Time>02:00:00</Time>
                  <DayOrder>1</DayOrder>
                  <Month>4</Month>
                  <DayOfWeek>Sunday</DayOfWeek>
                </DaylightTime>
              </TimeZone>
              <WorkingPeriodArray>
                <WorkingPeriod>
                  <DayOfWeek>Monday Tuesday Wednesday Thursday Friday</DayOfWeek>
                  <StartTimeInMinutes>480</StartTimeInMinutes>
                  <EndTimeInMinutes>1020</EndTimeInMinutes>
                </WorkingPeriod>
              </WorkingPeriodArray>
            </WorkingHours>
          </FreeBusyView>
        </FreeBusyResponse>
        <FreeBusyResponse>
          <ResponseMessage ResponseClass="Success">
            <ResponseCode>NoError</ResponseCode>
          </ResponseMessage>
          <FreeBusyView>
            <FreeBusyViewType xmlns="https://schemas.microsoft.com/exchange/services/2006/types">FreeBusyMerged</FreeBusyViewType>
            <MergedFreeBusy xmlns="https://schemas.microsoft.com/exchange/services/2006/types">000000001100000000000000</MergedFreeBusy>
            <CalendarEventArray xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
              <CalendarEvent>
                <StartTime>2006-10-16T09:00:00-07:00</StartTime>
                <EndTime>2006-10-16T10:00:00-07:00</EndTime>
                <BusyType>Tentative</BusyType>
              </CalendarEvent>
            </CalendarEventArray>
            <WorkingHours xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
              <TimeZone>
                <Bias>480</Bias>
                <StandardTime>
                  <Bias>0</Bias>
                  <Time>02:00:00</Time>
                  <DayOrder>5</DayOrder>
                  <Month>10</Month>
                  <DayOfWeek>Sunday</DayOfWeek>
                </StandardTime>
                <DaylightTime>
                  <Bias>-60</Bias>
                  <Time>02:00:00</Time>
                  <DayOrder>1</DayOrder>
                  <Month>4</Month>
                  <DayOfWeek>Sunday</DayOfWeek>
                </DaylightTime>
              </TimeZone>
              <WorkingPeriodArray>
                <WorkingPeriod>
                  <DayOfWeek>Monday Tuesday Wednesday Thursday Friday</DayOfWeek>
                  <StartTimeInMinutes>480</StartTimeInMinutes>
                  <EndTimeInMinutes>1020</EndTimeInMinutes>
                </WorkingPeriod>
              </WorkingPeriodArray>
            </WorkingHours>
          </FreeBusyView>
        </FreeBusyResponse>
      </FreeBusyResponseArray>
    </GetUserAvailabilityResponse>
  </soap:Body>
</soap:Envelope>

各ユーザーの空き時間情報は、一意のFreeBusyResponse要素に表示されます。The availability information for each user appears in a unique FreeBusyResponse element. Getuseravailability操作要求内のユーザーの順序によって、応答内の各ユーザーの可用性データの順序が決まります。The order of users in the GetUserAvailability operation request determines the order of availability data for each user in the response.

クエリに定義されている期間内の予定の数が管理者が指定した最大数を超えると、クライアントにエラーが返されます。An error will be returned to the client if the number of appointments in the time period that is defined in the query is greater than the administrator-specified maximum number. 予定の既定の最大数は、1万の1つのインスタンスと展開された定期的なアイテムです。The default maximum number of appointments is 10,000 single instances and expanded recurrence items. このプロパティは、管理者のみが構成できます。This property can be configured only by an administrator.

応答では、次の要素が使用されます。The following elements are used in the response:

関連項目See also