Web Service Documentation / Categories / Meter Services / Delete Consumption Data

Delete Consumption Data

Updated on June 28, 2021

Description

This web service deletes consumption data from a specific meter based on a specified optional date range. The meter must already be shared to you and you must have read write access. This web service supports the following meter types; energy, water, data center IT, drinking/waste water flow. Deleting the consumption data is permanent and cannot be undone.

NOTE: If you misspell the "startDate" or "endDate" parameter then the resulting behavior is equivalent to if the parameter was omitted. For example, if you run this web service and misspelled both date range parameters then all of the consumption data for that meter will be deleted which is the default behavior.

Version

18.0

HTTP Method

DELETE

Resource URL

/meter/(meterId)/consumptionData?startDate=(YYYY-MM-DD)&endDate=(YYYY-MM-DD)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
endDate Optional. Indicates the end date of a custom date range to delete consumption data. Must be a valid date formatted as YYYY-MM-DD.
meterId Id to the meter
startDate Optional. Indicates the start date of a custom date range to delete consumption data. Must be a valid date formatted as YYYY-MM-DD.

XML Schemas

Request/Response Schema Name
Request None
Response response.xsd

Example Requests

The following example deletes all the consumption data from the meter that has an id of 500.

DELETE  /meter/500/consumptionData

The following example deletes consumption data from the meter that has an id of 500 that covers a date range of January 1st, 2011 to December 31st.

DELETE  /meter/500/consumptionData?startDate=2011-01-01&endDate=2011-12-31

Example Response

The following example indicates that the consumption data was successfully deleted from the meter that has an id of 500.

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