Web Service Documentation / Categories / Meter Services / Edit Offsite Green Power Purchase

Edit Offsite Green Power Purchase

Updated on June 30, 2024

Description

This web service updates a specific offsite Green Power purchase record based on the information provided in the XML request. The corresponding property must already be shared with you and you must have write access to the property.

Version

24.0

HTTP Method

PUT

Resource URL

/offsiteGreenPowerPurchases/(id)

Header

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

Authorization Required

Yes

Parameters

Parameter Name Description
id Id to the offsite Green Power purchase record

XML Schemas

Request/Response Schema Name
Request offsitePurchase.xsd
Response response.xsd

Example Request

The following example updates a specific offsite Green Power purchase record that has an id of 181.

PUT  /offsiteGreenPowerPurchases/181

<?xml version="1.0" encoding="UTF-8"?>
<offsiteGreenPowerPurchase>
     <recOwnedAndRetired>true</recOwnedAndRetired>
     <type>Utility Green Tariff</type>
     <startDate>2023-01-01</startDate>
     <endDate>2023-07-01</endDate>
     <amountPurchased>
          <quantity uom="GJ">
               <amount>1000.1</amount>
          </quantity>
     </amountPurchased>
     <estimate>false</estimate>
     <generationLocation>
          <postalCode>21046</postalCode>
     </generationLocation>
     <certifiedByGreene>false</certifiedByGreene>
     <provider>Green Provider</provider>
     <facilityName>Green Facility Technologies</facilityName>
     <fuelSources>
          <fuelSource>
               <type>Wind</type>
               <percentage>50</percentage>
          </fuelSource>
          <fuelSource>
               <type>Solar</type>
          </fuelSource>
     </fuelSources>
     <renewableGenerationTechnologies>
          <technology>Solar PV- Rooftop</technology>
     </renewableGenerationTechnologies>
     <ratedCapacity uom="kW">
          <value>1000</value>
     </ratedCapacity>
     <operationDate>2000-01-01</operationDate>
     <contractStartDate>2023-01-01</contractStartDate>
     <contractEndDate>2023-12-31</contractEndDate>
     <cost uom="kWh (thousand Watt-hours)">
          <value>12.34</value>
     </cost>
     <notes>This is just an estimate.</notes>
</offsiteGreenPowerPurchase>

Example Response

The following example shows the result of updating the offsite Green Power purchase record.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <links>
          <link id="181" hint="Utility Green Tariff (2023-01-01 - 2023-07-01)" linkDescription="This is the GET url for this Offsite Green Power Purchase." link="/offsiteGreenPowerPurchases/181" httpMethod="GET"/>
     </links>
</response>
TEST