Documentation de service Web / Catégories / Services de signalement / Obtenir les mesures mensuelles sur une propriété

Obtenir les mesures mensuelles sur une propriété

Mise à jour le 27 août 2018

Description

Ce service Web affiche une liste de valeurs de mesure pour une propriété et une date de fin de période précises en fonction de l’ensemble de mesures et du système de mesure précisés. Chaque mesure mensuelle affichera 12 valeurs (une valeur pour chaque mois). Les mois affichés correspondent à tous les mois saisis qui tombent avant la date de fin de période annuelle précisée. Les mesures refléteront les totaux mensuels des compteurs auxquels vous avez accès.

Version

22.0

Méthode HTTP

GET

URL de la ressource

/propriété/(propriétéidentifiant)/mesures/mensuel?année=(année)&mois=(mois)&MesureSystème=(MesureSystème)

En-tête

Nom du champ Valeur Commentaires
Autorisation Basic authentifiant
Mesures-PM Identifiants de mesure séparés par des virgules Vous pouvez demander un maximum de 10 mesures par appel.

Autorisation requise

Oui

Paramètres

Nom du paramètre Description
measurementSystem Indique l’ensemble des unités à partir desquelles les mesures doivent être calculées. Les valeurs valides sont MESURE ou EPA. Il n’y a pas de valeur par défaut.
month Mois de la date de fin de période à partir duquel les mesures sont calculées. Les valeurs valides sont 1 12, 1 étant janvier et 12 étant décembre.
propertyId identifiant de propriété
year L’année de la date de fin de période pour laquelle les mesures doivent être calculées.

Schémas XML

Demande/réponse Nom de schéma
Demande Aucun
Réponse propriétémesures.xsd

Exemple de demande

Dans l’exemple suivant, l’énergie du site mensuelle (spécifiée dans l’en-tête HTTP) pour la propriété dont le numéro d’identification est 712 est récupérée pour la date de fin de période du 30 juin 2000. Les mesures ont été calculées en utilisant le système de mesure de l’EPA.

Mesure-PM : consommation mensuelle du site en électricité,consommation mensuelle du site en gaz naturel

GET  /property/712/metrics?year=2000&month=6&measurementSystem=EPA

Exemple de réponse

L’exemple suivant présente les résultats des mesures mensuelles déterminées. Veuillez noter qu’une réponse nulle sera retournée pour les mois où une valeur mensuelle ne peut pas être calculée

<?xml version="1.0" encoding="UTF-8"?>
<propertyMetrics propertyId="712" month="6" year="2000">
     <metric name="siteElectricityUseMonthly" uom="kBtu" dataType="numeric">
          <monthlyMetric month="6" year="2000">
               <value>56</value>
          </monthlyMetric>
          <monthlyMetric month="5" year="2000">
               <value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
          </monthlyMetric>
          <monthlyMetric month="4" year="2000">
               <value>66</value>
          </monthlyMetric>
          <monthlyMetric month="3" year="2000">
               <value>46</value>
          </monthlyMetric>
          <monthlyMetric month="2" year="2000">
               <value>66</value>
          </monthlyMetric>
          <monthlyMetric month="1" year="2000">
               <value>77</value>
          </monthlyMetric>
          <monthlyMetric month="12" year="1999">
               <value>51</value>
          </monthlyMetric>
          <monthlyMetric month="11" year="1999">
               <value>96</value>
          </monthlyMetric>
          <monthlyMetric month="10" year="1999">
               <value>56</value>
          </monthlyMetric>
          <monthlyMetric month="9" year="1999">
               <value>76</value>
          </monthlyMetric>
          <monthlyMetric month="8" year="1999">
               <value>66</value>
          </monthlyMetric>
          <monthlyMetric month="7" year="1999">
               <value>56</value>
          </monthlyMetric>
     </metric>

     <metric name="siteNaturalGasUseMonthly" uom="kBtu" dataType="numeric">
          <monthlyMetric month="6" year="2000">
               <value>156</value>
          </monthlyMetric>
          <monthlyMetric month="5" year="2000">
               <value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
          </monthlyMetric>
          <monthlyMetric month="4" year="2000">
               <value>166</value>
          </monthlyMetric>
          <monthlyMetric month="3" year="2000">
               <value>146</value>
          </monthlyMetric>
          <monthlyMetric month="2" year="2000">
               <value>166</value>
          </monthlyMetric>
          <monthlyMetric month="1" year="2000">
               <value>177</value>
          </monthlyMetric>
          <monthlyMetric month="12" year="1999">
               <value>151</value>
          </monthlyMetric>
          <monthlyMetric month="11" year="1999">
               <value>196</value>
          </monthlyMetric>
          <monthlyMetric month="10" year="1999">
               <value>156</value>
          </monthlyMetric>
          <monthlyMetric month="9" year="1999">
               <value>176</value>
          </monthlyMetric>
          <monthlyMetric month="8" year="1999">
               <value>166</value>
          </monthlyMetric>
          <monthlyMetric month="7" year="1999">
               <value>156</value>
          </monthlyMetric>
     </metric>
</propertyMetrics>
ENVIRONNEMENT DE PRODUCTION