Web Service Documentation / Categories / Reporting Services / Generate Data Response Preview

Generate Data Response Preview

Updated on October 10, 2023

Description

This web services generates a preview of a specific customer's data response. The customer can reference a user you're connected to or your own account.

Version

23.0

HTTP Method

POST

Resource URL

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

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 generates a preview for a specific data response that has an id of 9876 that belongs to a customer with an id of 675434.

POST  /reports/customers/675434/dataResponse/9876/generate

Example Response

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

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <link id="9876" httpMethod="GET" link="/reports/customers/675434/dataResponses/9876/status" linkDescription="This is the GET url for this DataResponse." hint="Energy Report 2023-DataRequest"/>
</response>
LIVE