Documentation de service Web / Catégories / Connexion/Services de partage / Obtenir des notifications

Obtenir des notifications

Mise à jour le 1 décembre 2021

Description

Ce service Web renvoie une liste des notifications qui sont générées lorsqu’un autre utilisateur supprime ou annule un partage d’une propriété ou d’un compteur auquel vous avez accès. Ces notifications ont pour but de vous aider à demeurer en phase avec les données de vos clients. Dès qu’une notification a été lue, elle est marquée « lue » (par défaut) et ne sera plus disponible lors des appels subséquents.Une option est disponible pour marquer ces notifications comme non lues.

Les types de notification possibles sont :
    UNSHARE - Indique que votre accès à une propriété ou à un compteur a été supprimé.
    SHAREUPDATE - Indique que votre niveau d'accès à une propriété ou à un compteur a été modifié.

Les types de notification DISCONNECT et TRANSFERPROPERTY ne sont pas pris en charge dans l'environnement Test. Veuillez consulter cette page FAQ pour plus d'informations.

Version

22.0

Méthode HTTP

GET

URL de la ressource

/notification/list?clear=(clear)

En-tête

Nom du champ Valeur Commentaires
Autorisation Basic authentifiant

Autorisation requise

Oui

Paramètres

Nom du paramètre Description
clear Indique si les avis doivent être cochés comme ayant été lus (réglé à vrai) ou non lus (réglé à faux). C’est facultatif et la valeur implicite est vrai.

Schémas XML

Demande/réponse Nom de schéma
Demande Aucun
Réponse autorisation.xsd

Exemples de demande

L'exemple suivant affiche la liste de l'ensemble courant de notifications. Par défaut, les notifications sont marquées comme «lues». Tous les appels subséquents n'inclueront pas ces éléments de notification.

GET  /notification/ liste

L'exemple suivant affiche la liste de l'ensemble courant de notifications, en les marquant comme «lues». Tous les appels subséquents n'inclueront pas ces éléments de notification.

GET  /notification/ liste? clair= vrai

L’exemple suivant extrait la liste des avis et coche les avis comme étant non lus. Tout appel subséquent inclura ces éléments d’avis.

GET  /notification/ liste? clair= faux

Exemple de réponse

L'exemple suivant affiche la liste de l'ensemble courant de notifications.

<?xml version="1.0" encoding="UTF-8"?>
<notificationList>
     <notification>
          <notificationTypeCode>UNSHARE</notificationTypeCode>
          <notificationId>1</notificationId>
          <description>Compteur électrique - Action résiliée par John Doe</description>
          <accountId>68005</accountId>
          <username>acme_user</username>
          <propertyId>5000006</propertyId>
          <meterId>2</meterId>
          <notificationCreatedDate>2014-12-20T11:50:44-04:00</notificationCreatedDate>
          <notificationCreatedBy>acme_john</notificationCreatedBy>
          <notificationCreatedByAccountId>68005</notificationCreatedByAccountId>
     </notification>
     <notification>
          <notificationTypeCode>DÉCONNECTER</notificationTypeCode>
          <notificationId>2</notificationId>
          <description>Vous êtes déconnecté de Jane Doe.</description>
          <accountId>68032</accountId>
          <username>bsimpson</username>
          <notificationCreatedDate>2014-12-21T11:50:44-04:00</notificationCreatedDate>
          <notificationCreatedBy>acme_jane</notificationCreatedBy>
          <notificationCreatedByAccountId>68032</notificationCreatedByAccountId>
     </notification>
     <notification>
          <notificationTypeCode>SHAREUPDATE</notificationTypeCode>
          <notificationId>3</notificationId>
          <description>Office Suite #10 - Niveau d'accès révisé pour l'échange de données - Lecture seule par Joe Doe.</description>
          <accountId>68005</accountId>
          <username>snoopy</username>
          <propertyId>5000206</propertyId>
          <notificationCreatedDate>2014-12-21T10:50:44-04:00</notificationCreatedDate>
          <notificationCreatedBy>acme_joe</notificationCreatedBy>
          <notificationCreatedByAccountId>98866</notificationCreatedByAccountId>
     </notification>
     <notification>
          <notificationTypeCode>TRANSFERPROPERTY</notificationTypeCode>
          <notificationId>4</notificationId>
          <description>Le bâtiment de la rive (453211) a été transféré sur le compte du propriétaire UTCOwner (202270)</description>
          <accountId>202270</accountId>
          <username>mjordan</username>
          <propertyId>453211</propertyId>
          <notificationCreatedDate>2014-12-19T10:50:44-04:00</notificationCreatedDate>
          <notificationCreatedBy>acme_jack</notificationCreatedBy>
          <notificationCreatedByAccountId>6574</notificationCreatedByAccountId>
     </notification>
</notificationList>
ENVIRONNEMENT D'ESSAI