announcement

During the current lapse in appropriations, EPA intends to keep the ENERGY STAR website, tools, and resources available, however they will not be updated regularly. Many services may not be available during this time.

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

Get Offsite Green Power Purchase

Updated on June 30, 2024

Description

This web service retrieves information for a specific offsite Green Power purchase record. The corresponding property must already be shared with you.

Version

25.0

HTTP Method

GET

Resource URL

/offsiteGreenPowerPurchases/(id)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

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

XML Schemas

Request/Response Schema Name
Request None
Response offsitePurchase.xsd

Example Request

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

GET  /offsiteGreenPowerPurchases/181

Example Response

The following example returns the offsite Green Power purchase record.

<?xml version="1.0" encoding="UTF-8"?>
<offsiteGreenPowerPurchase>
     <id>181</id>
     <recOwnedAndRetired>true</recOwnedAndRetired>
     <startDate>2020-01-01</startDate>
     <endDate>2020-01-31</endDate>
     <amountPurchased>
          <percentage>
               <value>80</value>
               <includeAllMeters>true</includeAllMeters>
          </percentage>
     </amountPurchased>
     <estimate>false</estimate>
     <generationLocation>
          <unknown>unknown</unknown>
     </generationLocation>
     <type>Community Choice Aggregation</type>
     <certifiedByGreene>true</certifiedByGreene>
     <provider>Green Providers</provider>
     <facilityName>DC Warehouse</facilityName>
     <operationDate>2020-01-01</operationDate>
     <contractStartDate>2020-01-01</contractStartDate>
     <contractEndDate>2022-12-31</contractEndDate>
     <audit>
          <createdBy>Green_ESP</createdBy>
          <createdDate>2024-05-30T07:09:18.000-04:00</createdDate>
          <lastUpdatedBy>Green_ESP</lastUpdatedBy>
          <lastUpdatedDate>2024-05-30T07:09:26.000-04:00</lastUpdatedDate>
     </audit>
</offsiteGreenPowerPurchase>
TEST