accessibility.link.skipToPageContent
accessibility.link.skipToCommonMenu
accessibility.link.skipToPublicMenu
header.banner.text
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 | /customer/(customerId)/propertyUse/whatChanged?date=(YYYY-MM-DD) | Returns a list of property uses that have had their name or use details modified since a specified date. |
| GET | /idHierarchy/propertyUse/(propertyUseId) | Returns the identifiers to the Property Data Administrator (accountId) and property for a specific property use. |
| 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 | /customer/(customerId)/useDetails/whatChanged?date=(YYYY-MM-DD) | Returns a list of property uses that have had their use details modified since a specified date. |
| 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?currentAsOfStart=(YYYY-MM-DD)¤tAsOfEnd=(YYYY-MM-DD) | 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 LIVE environment, relative to the base URI: https://portfoliomanager.energystar.gov/ws
Follow Us
