announcement

There has been a lapse in Environmental Protection Agency appropriations. EPA intends to keep the ENERGY STAR website, tools, and resources available, however they will not be updated regularly. If you submit a question, application, or request to EPA, it may not be processed during this period.

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

Get Offsite Green Power Purchase List

Updated on June 30, 2024

Description

This web service retrieves a list of all the offsite Green Power purchase records for a specific property. The property must already be shared with you.

Version

25.0

HTTP Method

GET

Resource URL

/property/(propertyId)/offsiteGreenPowerPurchases

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
propertyId Id to the property

XML Schemas

Request/Response Schema Name
Request None
Response response.xsd

Example Request

The following example retrieves a list of all of the offsite Green Power purchase records to a property that has an id of 841.

GET  /property/841/offsiteGreenPowerPurchases

Example Response

The following example returns a list of the offsite Green Power purchase records for the property.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <links>
          <link id="145" hint="Community Choice Aggregation (2023-01-01 - 2023-12-31)" linkDescription="This is the GET url for this Offsite Green Power Purchase." link="/offsiteGreenPowerPurchases/145" httpMethod="GET"/>
          <link id="2345" hint="Community Choice Aggregation (2022-01-01 - 2022-12-31)" linkDescription="This is the GET url for this Offsite Green Power Purchase." link="/offsiteGreenPowerPurchases/2345" httpMethod="GET"/>
          <link id="345773" hint="Competitive Product (direct purchase) (2023-01-01 - 2023-12-31)" linkDescription="This is the GET url for this Offsite Green Power Purchase." link="/offsiteGreenPowerPurchases/345773" httpMethod="GET"/>
     </links>
</response>
TEST