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

Add Consumption Data

Updated on June 28, 2021

Description

This web service adds consumption data to a specific meter based on the information provided in the XML request. It returns the unique identifier to each consumption data entry and a link to the corresponding web service to retrieve it. The meter must already be shared with you and you must have write access to the meter. This web service supports all meter types (i.e., electric, natural gas, water, IT, etc.). Green power information can also be added for renewable energy meter types. Demand tracking is also available for electric grid-purchase meters. A maximum of 120 consumption records is allowed.

Version

22.0

HTTP Method

POST

Resource URL

/meter/(meterId)/consumptionData

Header

Field Name Value Comments
Authorization Basic credentials
Content-Type application/xml

Authorization Required

Yes

Parameters

Parameter Name Description
meterId Id to the meter

XML Schemas

Request/Response Schema Name
Request meterConsumptionData.xsd
Response meterConsumptionData.xsd

Example Requests

The following example adds consumption data to the meter that has an id of 500.

POST  /meter/500/consumptionData

<?xml version="1.0" encoding="UTF-8"?>
<meterData>
    <meterConsumption>
        <usage>639573</usage>
        <startDate>2011-01-01</startDate>
        <endDate>2011-01-31</endDate>
    </meterConsumption>
    <meterConsumption>
        <usage>613123</usage>
        <startDate>2011-02-01</startDate>
        <endDate>2011-02-28</endDate>
    </meterConsumption>
</meterData>

The following example adds green power information to the meter that has an id of 501.

POST  /meter/501/consumptionData

<?xml version="1.0" encoding="UTF-8"?>
<meterData>
    <meterConsumption estimatedValue="false">
        <usage>1000</usage>
        <startDate>2010-03-15</startDate>
        <endDate>2010-04-14</endDate>
        <greenPower>
            <value>99</value>
            <sources>
                <biomassPct>0</biomassPct>
                <biogasPct>20</biogasPct>
                <geothermalPct>20</geothermalPct>
                <smallHydroPct>20</smallHydroPct>
                <solarPct>20</solarPct>
                <windPct>20</windPct>
                <unknownPct>0</unknownPct>
            </sources>
            <generationLocation>
                <generationPlant>56859</generationPlant>
            </generationLocation>
        </greenPower>
    </meterConsumption>
</meterData>

The following example adds consumption data and demand data to the meter that has an id of 502.

POST  /meter/502/consumptionData

<?xml version="1.0" encoding="UTF-8"?>
<meterData>
    <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>
</meterData>

The following example adds consumption data that specifies arbitrage for an onsite electric solar meter that has an id of 512.

POST  /meter/512/consumptionData

<?xml version="1.0" encoding="UTF-8"?>
<meterData>
     <meterConsumption estimatedValue="false">
          <startDate>2000-03-01</startDate>
          <endDate>2000-04-01</endDate>
          <energyExportedOffSite>22</energyExportedOffSite>
          <RECOwnership>Arbitrage</RECOwnership>
          <greenPower>
               <generationLocation>
                    <generationPlant>2</generationPlant>
               </generationLocation>
          </greenPower>
          <usage>222</usage>
     </meterConsumption>
     <meterConsumption estimatedValue="false">
          <startDate>2000-04-01</startDate>
          <endDate>2000-05-01</endDate>
          <energyExportedOffSite>11</energyExportedOffSite>
          <RECOwnership>Arbitrage</RECOwnership>
          <greenPower>
               <generationLocation>
                    <eGridSubRegion>AKGD</eGridSubRegion>
               </generationLocation>
          </greenPower>
          <usage>111</usage>
     </meterConsumption>
     <links/>
</meterData>

Example Response

The following example indicates that the consumption data was successfully added to the meter and this utility bill has an id of 745.

<?xml version="1.0" encoding="UTF-8"?>
<meterData>
    <meterConsumption estimatedValue="false">
        <id>745</id>
        <usage>1000</usage>
        <startDate>2010-03-15</startDate>
        <endDate>2010-04-14</endDate>
        <greenPower>
            <value>99</value>
            <sources>
                <biomassPct>0</biomassPct>
                <biogasPct>20</biogasPct>
                <geothermalPct>20</geothermalPct>
                <smallHydroPct>20</smallHydroPct>
                <solarPct>20</solarPct>
                <windPct>20</windPct>
                <unknownPct>0</unknownPct>
            </sources>
            <generationLocation>
                <generationPlant>56859</generationPlant>
            </generationLocation>
        </greenPower>
    </meterConsumption>
</meterData>
TEST