Export (0) Print
Expand All
Expand Minimize

GetReminders operation

Exchange Server 2013

Find information about the GetReminders EWS operation.

Last modified: April 28, 2014

Applies to: Exchange Online | Exchange Server 2013 | Office 365

In this article
Using the GetReminders operation
GetReminders operation request example
Successful GetReminders operation response
GetReminders operation error response example
Additional resources

The GetReminders Exchange Web Services (EWS) operation retrieves reminders for calendar and task items.

This operation was introduced in Exchange Server 2013.

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.

To retrieve all current reminders, we recommend setting the ReminderType to All and the EndTime to the current time.

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.

The following table describes the behavior of the ReminderType element when the BeginTime and EndTime elements are included.

ReminderType element value

Description

All

Reminders that occur between the BeginTime and EndTime.

Current

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. The BeginTime and EndTime elements must be set to use the Old value.

GetReminders operation SOAP headers

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

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.

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="http://schemas.microsoft.com/exchange/services/2006/messages" 
               xmlns:t="http://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>

The example request SOAP body contains the following elements:

The SOAP body can also contain the following elements:

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.

Note Note

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="http://schemas.microsoft.com/exchange/services/2006/types"
                       xmlns="http://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="http://schemas.microsoft.com/exchange/services/2006/messages">
      <ResponseCode>NoError</ResponseCode>
      <Reminders>
        <Reminder xmlns="http://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="http://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>

The response SOAP body contains the following elements:

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="http://schemas.microsoft.com/exchange/services/2006/types"
                       xmlns="http://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="http://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>

The error response SOAP body contains the following elements:

For additional error codes that are generic to EWS and specific to this operation, see ResponseCode.

Show:
© 2014 Microsoft