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 / Reporting Services / Get Data Responses

Get Data Responses

Updated on October 10, 2023

Description

This web service returns a list of all of data responses for a specific customer's data request. The customer can reference a user you're connected to or your own account.

Version

25.0

HTTP Method

GET

Resource URL

/reports/customers/(customerId)/dataResponses?status=(status)&dataRequestId=(dataRequestId)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
customerId Id of the customer
dataRequestId Optional. Id of the data request.
status Optional. Indicates the status of the data request. Valid values are:
  • OPEN
  • CLOSED
  • ALL
Defaults to ALL.

XML Schemas

Request/Response Schema Name
Request None
Response response.xsd

Example Request

The following example retrieves a list of all of the data responses for a specific data request with an id of 3434 with any status that belongs to a customer with an id of 675434.

GET  /reports/customers/675434/dataResponses?dataRequest=3434

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="9876" httpMethod="GET" link="/reports/customers/675434/dataResponses/9876" linkDescription="This is the GET url for this DataResponse." hint="Energy Report 2023-DataRequest"/>
          <link id="9877" httpMethod="GET" link="/reports/customers/675434/dataResponses/9877" linkDescription="This is the GET url for this DataResponse." hint="Energy Report 2023-DataRequest"/>
          <link id="9878" httpMethod="GET" link="/reports/customers/675434/dataResponses/9878" linkDescription="This is the GET url for this DataResponse." hint="Energy Report 2023-DataRequest"/>
          <link id="9879" httpMethod="GET" link="/reports/customers/675434/dataResponses/9879" linkDescription="This is the GET url for this DataResponse." hint="Energy Report 2023-DataRequest"/>
     </links>
</response>
LIVE