announcement

During the current lapse in appropriations, EPA intends to keep the ENERGY STAR website, tools, and resources available, however they will not be updated regularly. Many services may not be available during this time.

Web Service Documentation / Categories / Basic Account Services / Get Billboard Metric List

Get Billboard Metric List

Updated on August 25, 2019

Description

This web service returns a list of metrics that can be used for the "billboard" display. For more information on how to set the billboard display, see the "Account" and "Property" documentation sections.

Version

25.0

HTTP Method

GET

Resource URL

/billboardMetric/list

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

None

XML Schemas

Request/Response Schema Name
Request None
Response billboardMetricSetting.xsd

Example Request

The following example retrieves a list of customers that you are connected to.

GET  /billboardMetric/list

Example Response

The following example retrieves the list of available metrics that can be used to set the "billboard".

<?xml version="1.0" encoding="UTF-8"?>
<billboardMetrics>
     <metric name="score" dataType="numeric"/>
     <metric name="sourceIntensity" dataType="numeric"/>
     <metric name="siteIntensity" dataType="numeric"/>
     <metric name="siteIntensityWN" dataType="numeric"/>
     <metric name="sourceIntensityWN" dataType="numeric"/>
     <metric name="waterWasteWaterSiteIntensity" dataType="numeric"/>
     <metric name="waterWasteWaterSourceIntensity" dataType="numeric"/>
     <metric name="sourceTotal" dataType="numeric"/>
     <metric name="waterUseTotal" dataType="numeric"/>
     <metric name="totalWasteDisposedandDiverted" dataType="numeric"/>
     <metric name="energyCost" dataType="numeric"/>
     <metric name="waterCost" dataType="numeric"/>
     <metric name="totalWasteDisposedandDivertedCost" dataType="numeric"/>
     <metric name="totalGHGEmissions" dataType="numeric"/>
     <metric name="totalGHGEmissionsIntensity" dataType="numeric"/>
</billboardMetrics>
TEST