Operação GetReminders

Encontre informações sobre a operação GetReminders EWS.

A operação EWS ( GetReminders Exchange Web Services) recupera lembretes para itens de calendário e tarefa.

This operation was introduced in Exchange Server 2013.

Usando a operação GetReminders

A operação GetReminders obtém lembretes para itens de tarefas e calendário atuais e futuros na caixa de correio do usuário, dependendo dos valores de elemento passados na solicitação. A operação pode recuperar todos os itens de calendário atuais e futuros, bem como tarefas que têm um conjunto de lembretes. Itens de calendário privados são incluídos em respostas. Tarefas sem lembretes não são incluídas em respostas, nem emails com lembretes ou sinalizadores de acompanhamento.

Para recuperar todos os lembretes atuais, recomendamos definir o ReminderType como Todos e o EndTime para o momento atual.

Se os elementos BeginTime e EndTime forem incluídos na solicitação, a resposta inclui lembretes para qualquer calendário e itens de tarefa que ocorram entre ter um lembrete que ocorra entre o BeginTime e o EndTime.

A tabela a seguir descreve o comportamento do elemento ReminderType quando os elementos BeginTime e EndTime são incluídos.

Valor do elemento ReminderType Descrição
Todas
Lembretes que ocorrem entre o BeginTime e o EndTime.
Atual
Lembretes retornados por Todos, além de lembretes que são anteriores à janela de tempo solicitada se o evento ainda estiver em andamento, além de todos os compromissos, independentemente da idade.
Velho
Lembretes retornados por Todos, menos eventos que ainda não foram concluídos, menos todos os compromissos. Os elementos BeginTime e EndTime devem ser definidos para usar o valor Antigo .

Cabeçalhos SOAP da operação GetReminders

A operação GetReminders pode usar os cabeçalhos SOAP listados na tabela a seguir.

Nome de cabeçalho Elemento Descrição
Representação
ExchangeImpersonation
Identifica o usuário que o aplicativo cliente está representando. Esse cabeçalho é aplicável a uma solicitação.
MailboxCulture
MailboxCulture
Identifica a cultura, conforme definido no RFC 3066, "Marcas para a Identificação de Idiomas", a ser usada para acessar a caixa de correio. Esse cabeçalho é aplicável a uma solicitação.
RequestVersion
RequestServerVersion
Identifica a versão do esquema para a solicitação de operação. Esse cabeçalho é aplicável a uma solicitação.
Serverversion
ServerVersionInfo
Identifica a versão do servidor que respondeu à solicitação. Esse cabeçalho é aplicável a uma resposta.

Exemplo de solicitação de operação GetReminders

O exemplo a seguir de uma solicitação de operação GetReminders mostra como recuperar os cinco primeiros itens de calendário que ocorrem entre BeginTime e 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>

O corpo SOAP de solicitação de exemplo contém os seguintes elementos:

O corpo SOAP também pode conter os seguintes elementos:

Resposta bem-sucedida da operação GetReminders

O exemplo a seguir mostra uma resposta bem-sucedida a uma solicitação de operação GetReminders . A resposta contém um lembrete para o item de calendário "Reunião de equipe" e um lembrete para a tarefa "Tarefa para enviar anotações de reunião".

Observação

Os identificadores foram encurtados para preservar a legibilidade.

<?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>

O corpo SOAP de resposta contém os seguintes elementos:

Exemplo de resposta de erro da operação GetReminders

O exemplo a seguir mostra uma resposta de erro a uma solicitação de operação GetReminders . Essa é uma resposta a uma solicitação na qual a data de término era anterior à data de início.

<?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>

O corpo SOAP de resposta de erro contém os seguintes elementos:

Para obter códigos de erro adicionais que são genéricos para o EWS e específicos para essa operação, consulte ResponseCode.

Confira também