Операция GetRemindersGetReminders operation

Найдите сведения об операции с помощью службы EWS.Find information about the GetReminders EWS operation.

Операция веб- служб Exchange ( EWS) получает напоминания для элементов календаря и задач.The GetReminders Exchange Web Services (EWS) operation retrieves reminders for calendar and task items.

Эта операция появилась в Exchange Server 2013.This operation was introduced in Exchange Server 2013.

Использование операции "распоминать"Using the GetReminders operation

Операция по распамятке получает напоминания о текущем и будущем календаре и элементах задач в почтовом ящике пользователя в зависимости от значений элементов, переданных в запросе.The GetReminders operation gets reminders for current and future calendar and task items in the user's mailbox, depending on the element values passed in the request. Эта операция может получать все текущие и будущие элементы календаря, а также задачи, для которых задано напоминание.The operation can retrieve all current and future calendar items as well as tasks that have a reminder set. В ответы включаются элементы закрытого календаря.Private calendar items are included in responses. Задачи без напоминаний не включаются в отклики, а также не используются электронные письма с отметками и напоминаниями.Tasks without reminders are not included in responses, nor are emails with reminders or follow up flags.

Чтобы получить все текущие напоминания, рекомендуется установить для параметра реминдертипе значение ALL , а для свойства EndTime — текущее время.To retrieve all current reminders, we recommend setting the ReminderType to All and the EndTime to the current time.

Если в запрос включены элементы бегинтиме и EndTime , ответ включает в себя напоминания для всех элементов календаря и задач, которые происходят между бегинтиме и EndTime.If the BeginTime and EndTime elements are included in the request, the response includes reminders for any calendar and task items that occur between have a reminder that occurs between the BeginTime and EndTime.

В следующей таблице описывается поведение элемента реминдертипе при включении элементов бегинтиме и EndTime .The following table describes the behavior of the ReminderType element when the BeginTime and EndTime elements are included.

Значение элемента Реминдертипе * * * *****ReminderType** element value** ОписаниеDescription
ВсеAll
Напоминания, происходящие между бегинтиме и EndTime.Reminders that occur between the BeginTime and EndTime.
CurrentCurrent
Напоминания, возвращенные всеми, а также напоминания, предшествующие запрошенному окну времени, если событие продолжает выполняться, а также все встречи, независимо от возраста.Reminders returned by All, plus reminders that are earlier than the requested time window if the event is still ongoing, plus all appointments regardless of age.
РанееOld
Напоминания, возвращаемые всеми, за вычетом событий, которые еще не выполнены, за вычетом всех встреч.Reminders returned by All, minus events that haven't completed yet, minus all appointments. Для элементов бегинтиме и EndTime необходимо задать старое значение.The BeginTime and EndTime elements must be set to use the Old value.

Заголовков SOAP операции с раснапоминаниямиGetReminders operation SOAP headers

В операции " Пронапомнить " могут использоваться заголовки SOAP, перечисленные в следующей таблице.The GetReminders operation can use the SOAP headers that are listed in the following table.

Имя заголовкаHeader name ЭлементElement ОписаниеDescription
ОлицетворениеImpersonation
ексчанжеимперсонатионExchangeImpersonation
Идентифицирует пользователя, который олицетворяет клиентское приложение.Identifies the user whom the client application is impersonating. Этот заголовок является применимым для запроса.This header is applicable to a request.
маилбокскултуреMailboxCulture
маилбокскултуреMailboxCulture
Определяет язык и региональные параметры, определенные в документе 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.
рекуестверсионRequestVersion
рекуестсерверверсионRequestServerVersion
Определяет версию схемы для запроса операции.Identifies the schema version for the operation request. Этот заголовок является применимым для запроса.This header is applicable to a request.
серверверсионServerVersion
серверверсионинфоServerVersionInfo
Определяет версию сервера, который ответил на запрос.Identifies the version of the server that responded to the request. Этот заголовок является применимым для отклика.This header is applicable to a response.

Пример запроса операции с раснапоминаниямиGetReminders operation request example

В приведенном ниже примере запроса операции " Пронапомниться " показано, как получить первые пять элементов календаря, которые происходят между бегинтиме и EndTime.The following example of a GetReminders operation request shows how to retrieve the first five calendar items that occur between the BeginTime and EndTime.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:m="https://schemas.microsoft.com/exchange/services/2006/messages" 
               xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types" 
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <t:RequestServerVersion Version="Exchange2013" />
  </soap:Header>
  <soap:Body>
    <m:GetReminders>
      <m:EndTime>2014-04-16T21:00:00Z</m:EndTime>
      <m:ReminderType>All</m:ReminderType>
    </m:GetReminders>
  </soap:Body>
</soap:Envelope>

В примере сообщения SOAP Request содержатся следующие элементы:The example request SOAP body contains the following elements:

В теле SOAP также могут содержаться следующие элементы:The SOAP body can also contain the following elements:

Успешный ответ на операциюSuccessful GetReminders operation response

В приведенном ниже примере показан успешный ответ на запрос по операции GetResponse .The following example shows a successful response to a GetReminders operation request. Ответ содержит напоминание о задаче "собрание группы" и напоминание о задаче "задача по отправке заметок о собраниях".The response contains a reminder for the "Team meeting" calendar item and a reminder for the "Task to send meeting notes" task.

Примечание

Идентификаторы сокращены для сохранения удобочитаемости.Identifiers have been shortened to preserve readability.

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <ServerVersionInfo MajorVersion="15"
                       MinorVersion="0"
                       MajorBuildNumber="918"
                       MinorBuildNumber="7"
                       Version="V2_10"
                       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">
    <GetRemindersResponse ResponseClass="Success"
                          xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
      <ResponseCode>NoError</ResponseCode>
      <Reminders>
        <Reminder xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
          <Subject>Team meeting</Subject>
          <Location />
          <ReminderTime>2014-04-15T21:00:00Z</ReminderTime>
          <StartDate>2014-04-15T21:00:00Z</StartDate>
          <EndDate>2014-04-15T21:30:00Z</EndDate>
          <ItemId Id="vQAAAA=="
                  ChangeKey="DwAAABYAAAB4to43JyybTYwHLBM1k8MxAAACRoV4" />
          <RecurringMasterItemId Id="K7u5AAA=" ChangeKey="DwAAABYAAAB4to43JyybTYwHLBM1k8MxAAACRoV0" />
          <ReminderGroup>Calendar</ReminderGroup>
          <UID>6CF2FA62</UID>
        </Reminder>
        <Reminder xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
          <Subject>Task to send meeting notes</Subject>
          <Location />
          <ReminderTime>2014-04-16T14:00:00Z</ReminderTime>
          <StartDate>0001-01-02T00:00:00Z</StartDate>
          <EndDate>0001-01-02T00:00:00Z</EndDate>
          <ItemId Id="vAAAAA=="
                  ChangeKey="EwAAABQAAACOs0HEMq1WTKpI7sNu5qXNAAAIDg==" />
          <ReminderGroup>Task</ReminderGroup>
          <UID>vAAAAA==</UID>
        </Reminder>
      </Reminders>
    </GetRemindersResponse>
  </s:Body>
</s:Envelope>

Тело SOAP отклика содержит следующие элементы:The response SOAP body contains the following elements:

Пример ответа на сообщение об ошибке при выполнении операции с раснапоминаниямиGetReminders operation error response example

В приведенном ниже примере показан ответ об ошибке для запроса на операцию " Пронапомнить ".The following example shows an error response to a GetReminders operation request. Это ответ на запрос, в котором Дата окончания предшествует дате начала.This is a response to a request in which the end date was earlier than the start date.

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <ServerVersionInfo MajorVersion="15"
                       MinorVersion="0"
                       MajorBuildNumber="918"
                       MinorBuildNumber="7"
                       Version="V2_10"
                       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">
    <GetRemindersResponse ResponseClass="Error"
                          xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
      <MessageText>EndDate is earlier than StartDate</MessageText>
      <ResponseCode>ErrorInvalidOperation</ResponseCode>
      <DescriptiveLinkKey>0</DescriptiveLinkKey>
    </GetRemindersResponse>
  </s:Body>
</s:Envelope>

Основной текст сообщения об ошибке SOAP содержит следующие элементы:The error response SOAP body contains the following elements:

Дополнительные коды ошибок, которые являются общими для EWS и специфичными для этой операции, можно найти в разделе респонсекоде.For additional error codes that are generic to EWS and specific to this operation, see ResponseCode.

См. такжеSee also