Web Service Documentation / Categories / Property Use Services

Property Use Services

The Property Use Services allows you to define how a property will be used and operated. These services allow you to add, update, and delete the use types of a property as well as manage their operating characteristics.

Property Use

Method REST URI * Description
GET /idHierarchy/propertyUse/(propertyUseId) Returns the identifiers to the Property Data Administrator (accountId) and property for a specific property use.
GET /mapping/customer/(espCustID)/property/(espBldgID)/propertyUse/(espSpaceID) Returns the unique identifier to the specific property use. This service is intended for organizations that use the legacy ABS 2.5 system. The espSpaceID is a unique ID for each organization that offers web services. This mapping service returns EPA's corresponding spaceID in Portfolio Manager.
POST /property/(propertyId)/propertyUse Creates a property use under a specific property. The property must already be shared with you.
GET /property/(propertyId)/propertyUse/list Returns a list of property uses under a specific property. The property must already be shared with you.
GET /propertyUse/(propertyUseId) Returns information for a specific property use. The information includes general data about the property use itself and its most current use details information. The corresponding property must already be shared with you.
PUT /propertyUse/(propertyUseId) Updates a specific property use. Currently, the name can only be updated. The corresponding property must already be shared with you.
DELETE /propertyUse/(propertyUseId) Deletes a specific property use. The corresponding property must already be shared with you.

Use Details

Method REST URI * Description
GET /idHierarchy/useDetails/(useDetailId) Returns the identifiers to the Property Data Administrator (accountId), property, and property use for a specific use detail record.
POST /propertyUse/(propertyUseId)/useDetails Updates a specific set of property use details (e.g. operating hours, etc). The update is performed as a revision. The corresponding property must already be shared with you.
GET /propertyUse/(propertyUseId)/useDetailsRevisions Returns the revision history for a specific set of property use details. The corresponding property must be already shared with you.
GET /useDetails/(useDetailsId) Returns specific use detail information for a given use detail. The corresponding property must already be shared with you.
PUT /useDetails/(useDetailsId) Updates a specific set of property use details. The update is performed as a correction. The corresponding property must already be shared with you.

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

** Web services are only available in the TEST environment to simulate sharing process.

TEST