Web Service Documentation / Categories / Reporting Services / Get Design Metrics

Get Design Metrics

Updated on August 8, 2016

Description

This web service returns a list of metric values for a specific property design based on a specified measurement system. If the property contains operational data then an additional set of metric values based on the property's current period ending date is also returned. The property must already be shared with you. A full list of the reporting metrics that are available through this service and related web services can be found here. The list includes the metric name, the appropriate web service call for the metric, and a glossary link. It can be sorted and filtered for ease of finding the metrics that you need.

Note: Metrics that are readily available through other web services, such as GET /property/(propertyId)/design are not included in the reporting web services, since they are already accessible elsewhere.

Version

23.0

HTTP Method

GET

Resource URL

/property/(propertyId)/design/metrics?measurementSystem=(measurementSystem)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
measurementSystem Indicates the set of units for the metrics to be calculated from. Valid values are METRIC or EPA. There is no default value.
propertyId Id of the property

XML Schemas

Request/Response Schema Name
Request None
Response propertyMetrics.xsd

Example Requests

The following example retrieves 2 specific design metrics based on the design characteristics defined for a property that has an id of 712. The metrics were calculated using the METRIC measurement system.

PM-Metrics: designScore, designSiteTotal

GET  /property/712/design/metrics?measurementSystem=METRIC

The following example retrieves the standard set of design metrics based on the design characteristics defined for a property that has an id of 712. The metrics were calculated using the METRIC measurement system.

GET  /property/712/design/metrics?measurementSystem=METRIC

Example Response

The following example shows the results when you specify to retrieve all the metrics.

<?xml version="1.0" encoding="UTF-8"?>
<propertyMetrics propertyId="712">
    <metric name="designEnergyCost" dataType="numeric">
        <value>999.99</value>
    </metric>
    <metric name="designTotalGHGEmissions" dataType="numeric">
        <value>471.99</value>
    </metric>
    <metric name="designScore" dataType="numeric">
        <value>32</value>
    </metric>
    <metric name="designSiteTotal" dataType="numeric">
        <value>9999.99</value>
    </metric>
    <metric name="designSiteIntensity" dataType="numeric">
        <value>3333.33</value>
    </metric>
    <metric name="designSourceTotal" dataType="numeric">
        <value>33399.99</value>
    </metric>
    <metric name="designSourceIntensity" dataType="numeric">
        <value>11133.33</value>
    </metric>
    <metric name="designTargetEnergyCost" dataType="numeric">
        <value>1220.18</value>
    </metric>
    <metric name="designTargetTotalGHGEmissions" dataType="numeric">
        <value>575.92</value>
    </metric>
    <metric name="designTargetScore" dataType="numeric">
        <value>55</value>
    </metric>
    <metric name="designTargetSiteTotal" dataType="numeric">
        <value>8195.49</value>
    </metric>
    <metric name="designTargetSiteIntensity" dataType="numeric">
        <value>2731.83</value>
    </metric>
    <metric name="designTargetSourceTotal" dataType="numeric">
        <value>27372.94</value>
    </metric>
    <metric name="designTargetSourceIntensity" dataType="numeric">
        <value>9124.31</value>
    </metric>
    <metric name="medianEnergyCost" dataType="numeric">
        <value>1166.83</value>
    </metric>
    <metric name="medianTotalGHGEmissions" dataType="numeric">
        <value>550.73</value>
    </metric>
    <metric name="medianScore" dataType="numeric">
        <value>50</value>
    </metric>
    <metric name="medianSiteTotal" dataType="numeric">
        <value>8570.22</value>
    </metric>
    <metric name="medianSiteIntensity" dataType="numeric">
        <value>2856.74</value>
    </metric>
    <metric name="medianSourceTotal" dataType="numeric">
        <value>28624.52</value>
    </metric>
    <metric name="medianSourceIntensity" dataType="numeric">
        <value>9541.50</value>
    </metric>
</propertyMetrics>
TEST