Alertes

Sur quel élément de patrimoine rattacher les alertes ?

Les données d'alertes seront rattachées à un élément du bâti à savoir au logement, au local, à l'immeuble ou encore à la partie commune.

Remplacement de compteur

Vous devez toujours conserver le même flux (stream). Si le compteur est remplacé, on ne crée pas de nouveau flux, on conserve le même.

Comment transmettre les données ?

Pour transmettre les données, il vous faudra créer un stream de type events et l'alimenter en données.  ⁠⁠Evénements et alertes⁠ 
L'API à utiliser est l' API Data v1 .

Création du flux Alertes

Il vous faut créer un stream de type events, avec un dataType = alert et une activityKey = AlarmReport

POST api/data/v1/streams
{
  "reference": "STREAM-alert-1",
  "label": "Alerte compteur d'eau froide du logement 213LO98",
  "type": "events",
  "tags": {
    "intent_assetReference": "213LO98",
    "intent_activityKey": "AlarmReport",
    "intent_dataType": "alert",
    "intent_contractReference": "CONTRACT-10",
    "numéro de série": "16A8986765",
    "référence client": "G46245"
  }
}

Caractéristique du stream

Toutes les caractéristiques :  doc api en ligne 
Référence : Vous êtes libre de fixer la référence du stream. Elle doit cependant être unique pour toute votre entité et donc pour tous vos clients..

Label : Le label doit être compréhensible par tous les utilisateurs.

Alimenter le stream Alertes en données

Une fois que votre stream est créé, vous pouvez l'alimenter en données au fil de l'eau.

POST api/data/v1/events
{
  "streamReference": "STREAM-alert-1",
  "payload": [
    {
      "type": "Fuite",
      "status": "Début",
      "timestamp": 1504063834184
    }
  ]
}

POST api/data/v1/events
{
  "streamReference": "STREAM-alert-1",
  "payload": [
    {
      "type": "Fuite",
      "status": "Fin",
      "timestamp": 1504063934184
    }
  ]
}


Type et status

Sur intentPlatform, une alerte est caractérisée par un événement de début et un événement de fin, de clôture. L'utilisateur va paramétrer des seuils d'alertes qui vont créer une alerte lorsque l'événement de début d'alerte est transmis. L'alerte viendra automatiquement se clôturer, se fermer lorsque l'événement de clôture sera transmis.

Quelques exemples de type et status
Vous êtes libre de mettre au tant de type que vous souhaitez. Un type va correspondre à un type d'alerte que vous souhaitez transmettre.