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 Preview Data Response Results

Get Preview Data Response Results

Updated on October 10, 2023

Description

This web service retrieves a specific customer's data response preview. The data response must be in preview and not already submitted (i.e., sent). The customer can reference a user you're connected to or your own account. Depending on the size of the results, it either returns a file stream based on the file type you specify (Excel or XML) or a zip file. For more information on whether a zip file is returned, please see the Compressed and batched large Data Request download files bullet here.

Version

25.0

HTTP Method

GET

Resource URL

/reports/customers/(customerId)/dataResponses/(dataResponseId)/download?type=(type)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
customerId Id of the customer
dataResponseId Id of the data response
type The type of file to return as a stream. Valid values are:
  • EXCEL    (same as in the user interface)
  • XML

XML Schemas

Request/Response Schema Name
Request None
Response None

Example Request

The following example retrieves the information in an Excel file for a specific data response that has an id of 9876 that belongs to a customer with an id of 675434.

GET  /reports/customers/675434/dataResponse/9876/download?type=EXCEL

Example Response

An EXCEL file is streamed back.

<?xml version="1.0" encoding="UTF-8"?>
<null>
     <!-- Not applicable -->
</null>
LIVE