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

Obtenir les mesures de propriété

Mise à jour le 6 août 2014

Description

Ce service Web récupère une liste de valeurs des mesures pour une propriété spécifique et sa date de fin de période en fonction de l’ensemble de mesures et du système de mesures spécifiés. La propriété doit être déjà partagée avec vous. Vous trouverez ici une liste complète des mesures de rapport qui sont disponibles par l’entremise de ce service et des services Web connexes. Elle inclut le nom de la mesure, l’appel de service Web approprié et un lien vers le glossaire. Elle peut être triée et filtrée afin de vous aider à trouver facilement les mesures dont vous avez besoin.

Remarque : Les mesures qui sont déjà disponibles par l’entremise d’autres services Web, par exemple GET /property et GET /propertyUse, ne sont pas incluses dans les services Web des rapports, puisqu’ils sont déjà accessibles ailleurs.

Version

22.0

Méthode HTTP

GET

URL de la ressource

/property/(propertyId)/metrics?year=(year)&month=(month)&measurementSystem=(measurementSystem)

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 d’unités à partir duquel les mesures sont calculées. Les valeurs valides sont METRIC ou EPA. Il n’y a pas de valeur par défaut. Dans le cas où une ou plusieurs des mesures suivantes sont demandées collectivement ou individuellement, measurementSystem n’est pas requis : score, directGHGEmissions, inDirectGHGEmissions, totalGHGEmissions
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 la propriété
year Année de la date de fin de période à partir de laquelle les mesures sont calculées.

Schémas XML

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

Exemple de demande

L’exemple suivant récupère la cote et l’énergie du site (spécifiées dans l’en-tête HTTP) pour la propriété qui a un Identifiant de 712 et dont la date de fin de période est le 12/31/2000. Les mesures ont été calculées à l’aide du système de mesures METRIC.

PM-Metrics: score, siteTotal, sourceTotal,  siteIntensity, directGHGEmissions

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

Exemple de réponse

L’exemple suivant montre les résultats des mesures. Veuillez noter que les mesures des émissions directes de GES ne peuvent être calculées pour cette propriété. De plus, un attribut « uom » est fourni pour chaque mesure indiquant l’unité de mesure (s’il y a lieu).

<?xml version="1.0" encoding="UTF-8"?>
<propertyMetrics propertyId="712" month="12" year="2000" measurementSystem="EPA">
    <metric name="score" dataType="numeric">
        <value>75</value>
    </metric>
    <metric name="siteTotal" uom="kBtu" dataType="numeric">
        <value>197895.97966</value>
    </metric>
    <metric name="sourceTotal" uom="kBtu" dataType="numeric">
        <value>629036.25052</value>
    </metric>
    <metric name="siteIntensity" uom="kBtu/ft�" dataType="numeric">
        <value>7.915839</value>
    </metric>
    <metric name="directGHGEmissions" dataType="numeric">
        <value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
    </metric>
</propertyMetrics>
ENVIRONNEMENT D'ESSAI