Web Service Documentation / Categories / Meter Services / Add Optional Onsite Green Power Renewable Detail

Add Optional Onsite Green Power Renewable Detail

Updated on June 30, 2024

Description

This web service adds additional/optional onsite Green Power renewable detail information for a specific meter. Only one set of additional/optional information is tracked per meter. The corresponding meter must be an onsite renewable solar or wind meter. The meter must already be shared with you and you must have write access.

Version

24.0

HTTP Method

POST

Resource URL

/meter/(meterId)/onsiteRenewableOptionalInfo

Header

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

Authorization Required

Yes

Parameters

Parameter Name Description
meterId Id of the meter

XML Schemas

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

Example Request

The following example adds additional/optional onsite Green Power renewable detail record to a meter that has an id of 886412. This meter did not have any additional/optional onsite Green Power renewable detail information before.

POST  /meter/886412/onsiteRenewableOptionalInfo

<?xml version="1.0" encoding="UTF-8"?>
<onsiteRenewableOptionalInfo>
     <projectName>Project Solar Panels</projectName>
     <renewableGenerationTechnologies>
          <technology>Solar PV- Carports</technology>
          <technology>Other</technology>
     </renewableGenerationTechnologies>
     <ratedCapacity uom="kW">
          <value>123.4</value>
     </ratedCapacity>
     <operationDate>2022-02-01</operationDate>
     <numberOfInverters>3</numberOfInverters>
     <numberOfSolarPanels>12</numberOfSolarPanels>
     <totalCost>1945.12</totalCost>
     <incentiveOrRebateAmount>20000.5</incentiveOrRebateAmount>
     <estimatedSavings>12300.45</estimatedSavings>
     <notes>10 rounds of testing required.</notes>
</onsiteRenewableOptionalInfo>

Example Response

The following example shows the result of adding additional/optional onsite Green Power renewable detail information.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <links>
          <link id="886412" hint="Electric Solar Meter" linkDescription="This is the GET url for this Onsite Renewable Optional Info." link="/meter/886412/onsiteRenewableOptionalInfo" httpMethod="GET"/>
     </links>
</response>
TEST