Web Service Documentation / Categories / Reporting Services / Get Property Use Metrics

Get Property Use Metrics

Updated on August 6, 2014

Description

This web service returns a list of time-weighted use detail values for a specific property, period ending date, and measurement system. 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.

Version

9.0

HTTP Method

GET

Resource URL

/property/(propertyId)/useDetails/metrics?year=(year)&month=(month)&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.
month Month of the period ending date for the metrics to be calculated from. Valid values are 1-12 where 1 is January and 12 is December.
propertyId Id of the property
year Year of the period ending date for the metrics to be calculated from.

XML Schemas

Request/Response Schema Name
Request None
Response propertyMetrics.xsd

Example Request

The following example retrieves the time-weighted use detail values for the property that has an id of 712 with the period ending date of 12/31/2000. The metrics were calculated using the METRIC measurement system.



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

Example Response

The following example shows the results for the metrics. Also, a "uom" attribute is provided for each metric indicating the unit of measure (if applicable).

<propertyMetrics propertyId="712" month="12" year="2000" measurementSystem="EPA">
    <metric name="officeComputerDensity" uom="Number per 100 m²" dataType="numeric">
        <value>3.40857</value>
    </metric>
    <metric name="officeGrossFloorArea" uom="m²" dataType="numeric">
        <value>5574</value>
    </metric>
    <metric name="officeNumberOfComputers" dataType="numeric">
        <value>190.00</value>
    </metric>
    <metric name="officeNumberOfWorkersOnMainShift" dataType="numeric">
        <value>250.00</value>
    </metric>
    <metric name="officePercentThatCanBeCooled" dataType="numeric">
        <value>100.00</value>
    </metric>
    <metric name="officePercentThatCanBeHeated" dataType="numeric">
        <value>100.00</value>
    </metric>
    <metric name="officeWeeklyOperatingHours" dataType="numeric">
        <value>60.00</value>
    </metric>
    <metric name="officeWorkerDensity" uom="Number per 100 m²" dataType="numeric">
        <value>4.48496</value>
    </metric>
</propertyMetrics>
LIVE