Web Service Documentation / Categories / Reporting Services / Get Reasons for No Water Score

Get Reasons for No Water Score

Updated on October 31, 2017

Description

This web service returns a list of reasons that explain why the specific property cannot receive an ENERGY STAR score for a certain period ending date. If both the year and month are not provided then the property's current water period ending date is used. Please refer to this Alert Inventory for a list of possible reasons you might see in the response. Refer specifically to the alerts that are denoted "yes" in the N/A Explanations column; these are the alerts that apply when a metric, like the ENERGY STAR score, cannot be computed.

Version

9.0

HTTP Method

GET

Resource URL

/property/(propertyId)/reasonsForNoWaterScore?year=(year)&month=(month)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
month Optional. Month of the period ending date. Valid values are 1-12 where 1 is January and 12 is December. If both month and year are not specified, then the property's current water period ending date is used.
propertyId Id of the property
year Optional. Year of the period ending date. If both month and year are not specified, then the property's water current period ending date is used.

XML Schemas

Request/Response Schema Name
Request None
Response alerts.xsd

Example Requests

The following example retrieves the list of reasons that explain why the property cannot receive an ENERGY STAR water score for the period ending date of 12/31/2014.

GET  /property/712/reasonsForNoWaterScore?year=2014&month=12

The following example retrieves the list of reasons that explain why the property cannot receive an ENERGY STAR water score for its most current water period ending date. Note that both the year and month are not provided.

GET  /property/712/reasonsForNoWaterScore

Example Response

The following example shows the list of reasons why property 712 cannot receive an ENERGY STAR water score.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alerts propertyId="712" month="12" year="2014">
    <alert>
        <name>There is no available weather data for your location.</name>
        <description><b>Problem</b>: There is no available weather data for the zip code you entered. To compute the 
water score, we need information on ET and P50, which are determined based on zip code.<br/><br/><b>What to do</b>: 
Double check that you have entered the correct zip code for your location. If this zip code is correct and you are 
still unable to receive a score, contact us at <a href="https://portfoliomanager.zendesk.com/hc/en-us/requests/new" 
class="es-link">www.energystar.gov/BuildingsHelp</a>
        </description>
    </alert>
</alerts>
LIVE