Web Service Documentation / Categories / Property Services

Property Services

The Property Services allow you to manage properties and buildings within Portfolio Manager. You must be already connected to your customers to be able to manage their properties.

Property

Method REST URI * Description
POST /account/(accountId)/property Creates a property for the specified user. You must be already be connected to the user.
GET /account/(accountId)/property/list Returns a list of properties for a specified user. Only properties that you have access to will be returned. You must be already be connected to the user.
GET /idHierarchy/property/(propertyId) Returns the identifier to the Property Data Administrator (accountId) for a specific property.
GET /property/(propertyId) Returns information for a specific property. The property must already be shared with you. This service can also be used for a building.
PUT /property/(propertyId) Updates the information for a specified property. The property must already be shared with you.
DELETE /property/(propertyId) Deletes a specified property. The property must already be shared with you.

Design

Method REST URI * Description
GET /property/(propertyId)/design Returns the values for the set of design characteristics for an existing property. The property must already be shared with you.
PUT /property/(propertyId)/design Updates the set of design characteristics for an existing property. The property must already be shared with you.

Electric Distribution Utility

Method REST URI * Description
PUT /property/(propertyId)/edu/(eduId) Assigns a specific electric distribution utility to a given property. The electric emissions rate for this property will be based off of this electric distribution utility. The property must be already shared with you with write access.
GET /property/(propertyId)/edu/list Returns a list of electric distribution utilities which may be assigned to a specified property. The list also indicates the currently assigned electric distribution utility for the property. The property must be already shared with you with write access.

Power Generation Plant

Method REST URI * Description
DELETE /property/(propertyId)/pgp Removes the currently assigned power generation plant from the given property and leaves no power generation plant assigned to the property.
PUT /property/(propertyId)/pgp/(pgpId) Assigns a specific power generation plant to a given property. The electric emissions rate for this property will be based off of this power generation plant. The property must be already shared with you with write access.
GET /property/(propertyId)/pgp/list Returns a list of power generation plants for a specified property. The list also indicates the currently selected power generation plant for the property. The property must be already shared with you with write access.

Unique Identifiers

Method REST URI * Description
POST /property/(propertyId)/identifier Adds a property identifier (either standard or unique). The property must already be shared with you.
GET /property/(propertyId)/identifier/(identifierId) Returns the value for a specified property identifier for a given property. The property must already be shared with you.
PUT /property/(propertyId)/identifier/(identifierId) Updates the value for a specified identifier for a given property. The property must already be shared with you.
GET /property/(propertyId)/identifier/list Returns the list of identifier values for a specified property. The property must already be shared with you.
GET /property/identifier/list Returns a list of standard and unique identifiers that are currently approved for use by EPA.

Miscellaneous

Method REST URI * Description
GET /mapping/customer/(espCustID)/property/(espBldgID) Returns the identifier used within Portfolio Manager for a property based a specified espCustID / espBldgID combination from the ABS 2.5 legacy system.
GET /property/(propertyId)/baselineAndTarget Returns the baseline and target performance settings.
PUT /property/(propertyId)/baselineAndTarget Updates the baseline and target performance settings.
GET /property/(propertyId)/customFieldList Returns the list of custom fields and corresponding values for a specific property.
GET /property/eGridSubregion/list Returns a list of eGrid Subregions.
GET /property/federalAgency/list Returns a list of federal agencies.

Energy Performance Projects

Method REST URI * Description
GET /energyPerformanceProject/(energyPerformanceProjectId) Returns information for a specified energy performance project. The corresponding property must already be shared with you.
PUT /energyPerformanceProject/(energyPerformanceProjectId) Updates the information for a specified energy performance project. The corresponding property must already be shared with you.
DELETE /energyPerformanceProject/(energyPerformanceProjectId) Deletes a specified energy performance project. The corresponding property must already be shared with you.
POST /property/(propertyId)/energyPerformanceProject Adds an energy performance project for a specific property. The property must already be shared with you and you must have write access to the property.
GET /property/(propertyId)/energyPerformanceProject/list Returns a list of energy performance projects for a specified property. The property must already be shared with you.

* For the LIVE environment, relative to the base URI:  https://portfoliomanager.energystar.gov/ws

LIVE