Web Service Documentation / Categories / Property Services / Get Property PGP List

Get Property PGP List

Updated on June 28, 2021

Description

This web service returns a list of power generation plants (PGP) that are within the vicinity of a specific property. The property must be shared with you.

Version

24.0

HTTP Method

GET

Resource URL

/property/(propertyId)/pgp/list

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
propertyId Id to property

XML Schemas

Request/Response Schema Name
Request None
Response pgp.xsd

Example Request

The following example retrieves a list of power generation plants for a property that has an id of 200.

GET  /property/200/pgp/list

Example Response

The following example returns a list of power generation plants for a property that has an id of 200.

<?xml version="1.0" encoding="UTF-8"?>
<pgpList>
     <pgp eGridName="NEWE (New England)" eGridCode="NEWE" selected="false" name="ACME Nitrogen Operations" plantCode="59788"/>
     <pgp eGridName="NEWE (New England)" eGridCode="NEWE" selected="false" name="ACME Energy LLC" plantCode="6635"/>
</pgpList>
TEST