Web Service Documentation / Categories / Meter Services / Edit Meter Consumption Data
Updated on June 30, 2024
This web service updates a specific meter consumption data record based on the information provided in the XML request. The corresponding meter must already be shared with you and you must have write access to the meter.
23.0
PUT
/consumptionData/(consumptionDataId)
Field Name | Value | Comments |
---|---|---|
Authorization | Basic credentials | |
Content-Type | application/xml |
Yes
Parameter Name | Description |
---|---|
consumptionDataId | Id to the meter consumption data |
Request/Response | Schema Name |
---|---|
Request | meterConsumptionData.xsd |
Response | response.xsd |
The following example updates an existing meter consumption data record that has an id of 711.
PUT /consumptionData/711<?xml version="1.0" encoding="UTF-8"?> <meterConsumption> <usage>12345</usage> <startDate>2011-01-01</startDate> <endDate>2011-01-31</endDate> </meterConsumption>
The following example updates an existing meter consumption with demand data. To remove demand data from an existing consumption record, just omit the demand data from the XML. Demand data only applies to electric grid-purchase meters.
PUT /consumptionData/713<?xml version="1.0" encoding="UTF-8"?> <meterConsumption estimatedValue="false"> <usage>1000</usage> <startDate>2010-03-15</startDate> <endDate>2010-04-14</endDate> <demandTracking> <demand>99</demand> <demandCost>5859</demandCost> </demandTracking> </meterConsumption>
The following example updates an existing meter consumption while deleting the corresponding cost value. To update the existing meter consumption value while not preserving the existing cost value, just omit the cost data from the XML.
PUT /consumptionData/713<?xml version="1.0" encoding="UTF-8"?> <meterConsumption estimatedValue="false"> <usage>1000</usage> <startDate>2010-03-15</startDate> <endDate>2010-04-14</endDate> <cost/> </meterConsumption>
The following example indicates that the meter consumption data was updated successfully.
<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
<id>711</id>
<links>
<link httpMethod="GET" link="/meter/1/consumptionData" linkDescription="This is the GET url for this Meter Consumption Data."/>
</links>
</response>