announcement

There has been a lapse in Environmental Protection Agency appropriations. EPA intends to keep the ENERGY STAR website, tools, and resources available, however they will not be updated regularly. If you submit a question, application, or request to EPA, it may not be processed during this period.

Web Service Documentation / Categories / Reporting Services / Get Report Template List

Get Report Template List

Updated on February 12, 2023

Description

This web service returns a list of report templates in your account.

Version

25.0

HTTP Method

GET

Resource URL

/reports/templates?type=(type)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
type Optional. Indicates the type of report templates to return. Valid values are:
  • CUSTOM
  • ENERGY_STAR
  • DATA_REQUEST
Defaults to all. Currently CUSTOM and ENERGY_STAR only supported at this time.

XML Schemas

Request/Response Schema Name
Request None
Response response.xsd

Example Request

The following example retrieves all the custom report templates.

GET  /reports/templates?type=CUSTOM

Example Response

The following example shows the results when you call this web service.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <links>
          <link id="86123" httpMethod="GET" link="/reports/templates/86123" linkDescription="This is the GET url for this Template." hint="Energy Report 2022"/>
          <link id="18634" httpMethod="GET" link="/reports/templates/18634" linkDescription="This is the GET url for this Template." hint="Water Report 2022"/>
          <link id="8666" httpMethod="GET" link="/reports/templates/8666" linkDescription="This is the GET url for this Template." hint="City 2022 Data Request"/>
          <link id="85116" httpMethod="GET" link="/reports/templates/85116" linkDescription="This is the GET url for this Template." hint="Partner of the Year Report"/>
     </links>
</response>
TEST