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 Response Status

Get Data Response Status

Updated on October 10, 2023

Description

This web service returns the information on the status of a specific customer's data response and any helpful information to troubleshoot errors. The customer can reference a user you're connected to or your own account.

The following are valid statuses:
  • INITIALIZED - Indicates that the configuration of the data response was initially created or its configuration (i.e., properties) has been updated.
  • SUBMITTED - Indicates that the data response has been submitted for generation and is waiting to be generated.
  • IN_PROCESS - Indicates that the data response is currently being generated.
  • FAILED - Indicates that the data response completed generating but has encountered an unknown error.
  • GENERATED - Indicates that data response has completed generating with no errors.
  • GENERATED_WITH_ERRORS - Indicates that data response has completed generating with no errors. Links are provided to download the errors.
  • SENT - Indicates that the data response has been sent.

Version

25.0

HTTP Method

GET

Resource URL

/reports/customers/(customerId)/dataResponses/(dataResponseId)/status

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

XML Schemas

Request/Response Schema Name
Request None
Response response.xsd

Example Request

The following example retrieves the status of 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/status

Example Responses

The following example shows the results when you call this web service that does not contain any errors.

<?xml version="1.0" encoding="UTF-8"?>
<responseStatus>
     <status>GENERATED</status>
     <generationStartDate>2023-01-20T15:59:48.696-05:00</generationStartDate>
     <generationEndDate>2023-01-20T15:25:48.752-05:00</generationEndDate>
     <submittedDate>2023-01-10T16:25:48.659-05:00</submittedDate>
</responseStatus>

The following example shows the results when you call this web service that contains errors. Links are included to help

<?xml version="1.0" encoding="UTF-8"?>
<responseStatus>
     <status>GENERATED_WITH_ERRORS</status>
     <generationStartDate>2023-01-20T15:59:48.696-05:00</generationStartDate>
     <generationEndDate>2023-01-20T15:25:48.752-05:00</generationEndDate>
     <submittedDate>2023-01-10T16:25:48.659-05:00</submittedDate>
     <errors>
          <links>
               <link id="9876" httpMethod="GET" link="/ws/reports/customers/675434/dataResponses/9876/errors/download?type=EXCEL" linkDescription="This is the GET url for this DataResponse Errors." hint="Energy Report 2023-DataRequest"/>
               <link id="9876" httpMethod="GET" link="/ws/reports/customers/675434/dataResponses/9876/errors/download?type=XML" linkDescription="This is the GET url for this DataResponse Errors." hint="Energy Report 2023-DataRequest"/>
          </links>
     </errors>
</responseStatus>
LIVE