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

Add Offsite Green Power Purchase

Updated on June 30, 2024

Description

This web service adds a new offsite Green Power purchase record to a specific property 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

POST

Resource URL

/property/(propertyId)/offsiteGreenPowerPurchases

Header

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

Authorization Required

Yes

Parameters

Parameter Name Description
propertyId Id to the property

XML Schemas

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

Example Request

The following example adds a specific offsite Green Power purchase record to a property that has an id of 841.

POST  /property/841/offsiteGreenPowerPurchases

<?xml version="1.0" encoding="UTF-8"?>
<offsiteGreenPowerPurchase>
     <recOwnedAndRetired>true</recOwnedAndRetired>
     <type>Unbundled RECs</type>
     <meetVintageRequirement>true</meetVintageRequirement>
     <startDate>2023-01-01</startDate>
     <endDate>2023-07-01</endDate>
     <amountPurchased>
          <percentage>
               <value>100</value>
               <includeAllMeters>false</includeAllMeters>
               <meters>
                    <id>1</id>
               </meters>
          </percentage>
     </amountPurchased>
     <estimate>false</estimate>
     <generationLocation>
          <eGridSubRegion>AKMS</eGridSubRegion>
     </generationLocation>
     <certifiedByGreene>true</certifiedByGreene>
     <provider>Renewable Systems</provider>
     <facilityName>Renewable Systems Premiere</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 an estimate.</notes>
</offsiteGreenPowerPurchase>

Example Response

The following example shows the result of adding an offsite Green Power purchase record. Note that the hint attribute is set to the Green Power type and the start/end dates.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <links>
          <link id="181" hint="Unbundled RECs (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>
LIVE