Opération GetReminders

  • Article

Recherchez des informations sur l’opération GetReminders EWS.

L’opération GetReminders Exchange Web Services (EWS) récupère des rappels pour les éléments de calendrier et de tâche.

Cette opération est une nouveauté d’Exchange Server 2013.

Utilisation de l’opération GetReminders

L’opération GetReminders obtient des rappels pour les éléments de tâches et de calendrier actuels et futurs dans la boîte aux lettres de l’utilisateur, en fonction des valeurs d’élément passées dans la requête. L’opération peut récupérer tous les éléments de calendrier actuels et futurs, ainsi que les tâches qui ont un jeu de rappels. Les éléments de calendrier privés sont inclus dans les réponses. Les tâches sans rappels ne sont pas incluses dans les réponses, pas plus que les e-mails avec des rappels ou des indicateurs de suivi.

Pour récupérer tous les rappels actuels, nous vous recommandons de définir ReminderType sur All et endTime sur l’heure actuelle.

Si les éléments BeginTime et EndTime sont inclus dans la demande, la réponse inclut des rappels pour tous les éléments de calendrier et de tâche qui se produisent entre ont un rappel qui se produit entre BeginTime et EndTime.

Le tableau suivant décrit le comportement de l’élément ReminderType lorsque les éléments BeginTime et EndTime sont inclus.

Valeur de l’élément ReminderType Description
tous
 Rappels qui se produisent entre les valeurs BeginTime et EndTime.
Current
 Rappels retournés par Tous, plus les rappels antérieurs à la fenêtre de temps demandée si l’événement est toujours en cours, ainsi que tous les rendez-vous, quel que soit l’âge.
Vieux
 Rappels retournés par Tous, moins les événements qui ne se sont pas encore terminés, moins tous les rendez-vous. Les éléments BeginTime et EndTime doivent être définis pour utiliser la valeur Old .

En-têtes SOAP de l’opération GetReminders

L’opération GetReminders peut utiliser les en-têtes SOAP répertoriés dans le tableau suivant.

Nom de l'en-tête Élément Description
Imitation
ExchangeImpersonation
Identifie l’utilisateur que l’application cliente emprunte l’identité. Cet en-tête s’applique à une requête.
MailboxCulture
MailboxCulture
Identifie la culture, telle que définie dans la RFC 3066, « Balises pour l’identification des langues », à utiliser pour accéder à la boîte aux lettres. Cet en-tête s’applique à une requête.
RequestVersion
RequestServerVersion
Identifie la version du schéma pour la demande d’opération. Cet en-tête s’applique à une requête.
ServerVersion
ServerVersionInfo
Identifie la version du serveur qui a répondu à la requête. Cet en-tête s’applique à une réponse.

Exemple de demande d’opération GetReminders

L’exemple suivant de demande d’opération GetReminders montre comment récupérer les cinq premiers éléments de calendrier qui se produisent entre beginTime et 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>

L’exemple de corps SOAP de la demande contient les éléments suivants :

Le corps SOAP peut également contenir les éléments suivants :

Réponse de l’opération GetReminders réussie

L’exemple suivant montre une réponse réussie à une demande d’opération GetReminders . La réponse contient un rappel pour l’élément de calendrier « Réunion d’équipe » et un rappel pour la tâche « Tâche d’envoi de notes de réunion ».

Remarque

Les identificateurs ont été raccourcis pour préserver la lisibilité.

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

Le corps SOAP de la réponse contient les éléments suivants :

Exemple de réponse d’erreur d’opération GetReminders

L’exemple suivant montre une réponse d’erreur à une demande d’opération GetReminders . Il s’agit d’une réponse à une demande dans laquelle la date de fin était antérieure à la date de début.

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

Le corps SOAP de la réponse d’erreur contient les éléments suivants :

Pour obtenir des codes d’erreur supplémentaires génériques pour EWS et spécifiques à cette opération, consultez ResponseCode.

Voir aussi