Web Service Documentation / Categories / Property Use Services
The Property Use Services allows you to define how a property will be used and operated. These services are divided into 3 sections. The first two sections (Property Use and Use Details) allow you to add, update, and delete the use types of a property as well as manage their operating characteristics. The third section (Custom Property Use and Use Details) allows you to optionally create up to two new Custom Property Use Details so you can track information that is most meaningful to your organization. To learn more on how Custom Use Details, please reference this FAQ.
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. |
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. |
Method | REST URI * | Description |
---|---|---|
GET | /customUse/(propertyId) | Returns information for the custom property use if one has been defined for the specified property. The information includes general data about the custom use details that were created to track information that is meaningful to your organization. |
GET | /customUse/(propertyId)/detailRevisions?currentAsOfStart=(YYYY-MM-DD)¤tAsOfEnd=(YYYY-MM-DD) | Returns the custom use details revision history of the custom property use. The corresponding property must be already shared to you. |
POST | /customUse/(propertyId)/details | Updates a specific set of custom use details information. The update is performed as a revision. The corresponding property must already be shared to you. |
GET | /customUse/details/(detailsId) | Returns specific use detail information for a given custom use detail. The corresponding property must already be shared with you. |
PUT | /customUse/details/(detailsId) | Updates a specific set of custom use details information. The update is performed as a correction. The corresponding property must already be shared to you. |
DELETE | /customUse/details/(detailsId) | Deletes a specific custom use detail. |
* For the TEST environment, relative to the base URI: https://portfoliomanager.energystar.gov/wstest
** Web services are only available in the TEST environment.