Web Service Documentation / Categories / Reporting Services / Get Data Response Status
Updated on October 10, 2023
23.0
GET
/reports/customers/(customerId)/dataResponses/(dataResponseId)/status
Field Name | Value | Comments |
---|---|---|
Authorization | Basic credentials |
Yes
Parameter Name | Description |
---|---|
customerId | Id of the customer |
dataResponseId | Id of the data response |
Request/Response | Schema Name |
---|---|
Request | None |
Response | response.xsd |
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
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>