Web Service Documentation / Categories / Reporting Services / Submit Data Response

Submit Data Response

Updated on October 10, 2023

Description

This web service submits and finalizes a specific customer's data response. The submission includes a list of email addresses that will receive a confirmation, the file format of the copy of the data that is attached to the email attachment, and whether the submission should ignore any errors where a Site EUI and/or Total Water Use calculations could not be determined. The customer can reference a user you're connected to or your own account.

Note that the E-Sign Response step that is in the user interface is implied in this web service.

Version

22.0

HTTP Method

POST

Resource URL

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

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 sendDataResponse.xsd
Response response.xsd

Example Request

The following example submits the data response 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/send

<?xml version="1.0" encoding="UTF-8"?>
<sendDataResponse>
     <additionalEmailAddresses>
          <email>john.doe@acme.com</email>
          <email>jane.doe@acme.com</email>
     </additionalEmailAddresses>
     <fileFormat>EXCEL</fileFormat>
     <submitWithErrors>true</submitWithErrors>
</sendDataResponse>

Example Response

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

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok"/>
LIVE