Index de consommation

Sur quel élément de patrimoine rattacher la consommation ?

Les données de consommation 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.Le flux est donc lié à un "point de comptage" et non à un "équipement compteur" ⁠⁠Vocabulaire⁠ 

Remise à 0 du compteur

IntentPlatform attend à toujours recevoir un index croissant. Si le compteur voit son index être remis à 0, vous devrez le prendre en compte afin de continuer à transmettre un index croissant et non de repartir à 0.

Comment transmettre les données

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

Index

Il vous faut créer un stream de type metrics et avec un dataType = snapshot.
La référence du stream est {RéférencePointdecomptage}-{activityKey}
{
  "reference": "449876543-GlobalWaterCons",
  "label": "index d'eau froide du logement 213LO98",
  "type": "metrics",
  "tags": {
    "intent_unit": "m3",
    "intent_assetReference": "213LO98",
    "intent_activityKey": "GlobalWaterCons",
    "intent_dataType": "snapshot",
    "intent_frequency": 60, //ou 1440 pour une fréquence quotidienne
    "intent_contractReference": "CONTRACT-10",
    "point de comptage": "449876543"
    "numéro de série": "16A8986765",
    "référence client": "G46245" //facultatif
  }
}

Caractéristique du stream

Toutes les caractéristiques :  doc api en ligne 
Title
Title
Champ
Description
intent_assetReference
référence de l'élément de patrimoine où la mesure est faite
intent_activityKey
  • GlobalWaterCons : conso générale d'eau froide
  • GlobalHotWaterCons : conso générale d'eau chaude
  • WaterCons : sous comptage eau froide (divisionnaire - logement)
  • HotWaterCons : sous comptage eau chaude (divisionnaire - logement)
point de comptage
référence du point de comptage (PCE/PRM/PDL)
numéro de série
numéro de série du compteur qui mesure la consommation
référence client
la référence du compteur côté client (si vous la connaissez)
Label : Le label doit être compréhensible par tous les utilisateurs.

Alimenter le stream index en données

Une fois que votre stream est créé, vous pouvez l'alimenter en données au fil de l'eau.
POST /events
{
  "streamReference": "449876543-GlobalWaterCons",
  "payload": [
    {
      "value": 124,
      "timestamp": 1504063834184
    },
    {
      "value": 134,
      "timestamp": 1505063834184
    },
    {
      "value": 144,
      "timestamp": 1506063834184
    }
  ]
}

Vous pouvez transmettre plusieurs données mesurées dans 1 seul appel API. Les différentes données mesurées sont à indiquer dans le payload. Ceci vous permet notamment de transmettre toutes les données mesurées sur les 24 dernières heures en 1 seul appel API.