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 générées lorsqu’un autre utilisateur supprime une propriété ou un compteur auquel vous avez accès, ou en annule le partage. Ces notifications ont pour but de vous aider à demeurer en phase avec les données de vos clients. Lorsqu’une notification est lue, elle est marquée comme lue (par défaut) et ne sera plus disponible lors des appels subséquents. Une option permet de 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 d’essai. Veuillez consulter cette page FAQ pour obtenir plus de renseignements.

Version

27.0

Méthode HTTP

GET

URL de la ressource

/notification/list?clear=(clear)

En-tête

Nom du champ Valeur Commentaires
Authorization Basic authentifiant

Autorisation requise

Oui

Paramètres

Nom du paramètre Description
clear Indique s’il faut marquer les notifications comme lues (valeur true) ou non lues (valeur false). Ce paramètre est facultatif et sa valeur par défaut est true.

Schémas XML

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

Exemples de demande

L’exemple suivant récupère la liste des notifications. Par défaut, les notifications sont marquées comme « lues ». Les appels subséquents n’incluront pas ces éléments de notification.

GET  /notification/ liste

L’exemple suivant récupère la liste des notifications et les marque comme « lues ». Les appels subséquents n’incluront pas ces éléments de notification.

GET  /notification/ liste? clair= vrai

L’exemple suivant récupère la liste des notifications et les marque comme non lues. Les appels subséquents incluront ces éléments de notification.

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>Electric Meter - Share terminated by 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>DISCONNECT</notificationTypeCode>
          <notificationId>2</notificationId>
          <description>You are disconnected from 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 - Access level revised to Exchange Data - Read Only by 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>Shoreline Building (453211) has been transferred to owner account 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