Web Service Documentation / Categories / Reporting Services / Get Data Requests

Get Data Requests

Updated on October 10, 2023

Description

This web service returns a list of data requests that were accessed by a specific customer. 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?status=(status)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
customerId Id of the customer
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 lists of all of the data requests for a customer with an id of 675434.

GET  /reports/customers/675434/dataRequests

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="34343" httpMethod="GET" link="/reports/customers/675434/dataRequests/34343" linkDescription="This is the GET url for this DataRequest." hint="Energy Report 2023-DataRequest"/>
     </links>
</response>
LIVE