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 Data Request

Get Data Request

Updated on October 10, 2023

Description

This web service returns the information 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)/dataRequests/(dataRequestId)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
customerId Id of the customer
dataRequestId Id of the data request

XML Schemas

Request/Response Schema Name
Request None
Response dataRequest.xsd

Example Request

The following example returns information for the data request with an id of 34343 that belongs to a customer with an id of 675434.

GET  /reports/customers/675434/dataRequests/34343

Example Response

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

<?xml version="1.0" encoding="UTF-8"?>
<dataRequest id="34343">
     <name>Data Request:test</name>
     <requesterDetails>
          <firstName>John</firstName>
          <lastName>Doe</lastName>
          <email>john_doe@acme.com</email>
          <phone>123-456-7890</phone>
     </requesterDetails>
     <instructions><![CDATA[<strong>Instructions:</strong> Please comply with this data request.]]></instructions>
     <timeframe>   <singlePeriod>
               <periodEndingDate>
                    <month>12</month>
                    <year>2022</year>
               </periodEndingDate>
          </singlePeriod>
     </timeframe>
     <dataRequestStatus>OPEN</dataRequestStatus>
     <dataRequestAcceptedBy>NPS</dataRequestAcceptedBy>
     <dataRequestAcceptedDate>2023-01-16T17:09:35-04:00</dataRequestAcceptedDate>
</dataRequest>
LIVE