What changes will be made as part of the February 2025 web services 24.0 release?

  • Updated

The Beta release of the Portfolio Manager web services 24.0 schemas will be available to the public on December 9, 2024. The Live release will be available to the public on February 24, 2025. During this interim period, the web services TEST environment will be running 24.0 while the LIVE environment will be running 23.0.

A schema release webinar for Web services providers and other interested parties was held on December 11, 2024. You can view a recording of this webinar here.

Planned enhancements for the Portfolio Manager web services 24.0 Beta release on December 9, 2024 and Live release on February 24, 2025

  • New "Fire Station" score models for Canadian buildings
    • Score Updates
      • U.S. “Fire Station” properties remain ineligible to receive the 1-100 score.
      • New Canadian scores will be available for properties containing the "Fire Station" use type. These properties will be updated with new Use Details (see below).
      • If you benchmark Fire Stations, you will see use detail updates when you use the set of API calls that manage use details. These calls are listed below in the section labeled “The services noted below will be impacted by these use detail changes….”
    • New Use Details
      • Number of Full-Time-Equivalent Workers
        • Web services name: numberOfFTEWorkers
      • Weekly Building Occupied Hours
        • Web services name: weeklyBuildingOccupiedHours
      • Number of Emergency Vehicles
        • Web services name: numberOfEmergencyVehicles
      • Number of Annual Emergency Incidents
        • Web services name: numberOfAnnualEmergencyIncidents
      • Percent That Can Be Heated
        • Web services name: percentHeated
      • Percent That Can Be Cooled
        • Web services name: percentCooled
  • Existing “Fire Station” property uses will be backfilled with default values
    • Number of Full-Time-Equivalent Workers
      • Backfill with default value of "0."
    • Weekly Building Occupied Hours
      • Backfill with default value of "0."
    • Number of Emergency Vehicles
      • Backfill with default value of "0."
    • Number of Annual Emergency Incidents
      • Backfill with default value of "0."
    • Percent That Can Be Heated
      • Backfill with default value of "0."
    • Percent That Can Be Cooled
      • Backfill with default value of "0."
  • The services noted below will be impacted by these use detail changes
    • POST /property/(propertyId)/propertyUse
    • GET /propertyUse/(propertyUseId)
    • POST /propertyUse/(propertyUseId)/useDetails
    • GET /propertyUse/(propertyUseId)/useDetailsRevisions
    • PUT/GET /useDetails/(useDetailsId)
    • GET /idHierarchy/useDetails/(useDetailId)
    • PUT/GET /property/(propertyId)/design
    • POST /targetFinder
  • New Use Detail Metrics will be available via the Get-Use-Details-Metrics web service:
    • fireStationFullTimeEquivalentFteWorkers
    • fireStationFullTimeEquivalentFteWorkerDensity
    • fireStationWeeklyBuildingOccupiedHours
    • fireStationNumberOfEmergencyVehicles
    • fireStationEmergencyVehicleDensity
    • fireStationNumberOfAnnualEmergencyIncidents
    • fireStationPercentThatCanBeHeated
    • fireStationPercentThatCanBeCooled

 

  • New user interface for the Portfolio Manager TEST environment
    • Response to longstanding API user requests!
      • Supported by funding from the Inflation Reduction Act of 2022 to advance the goal of reducing greenhouse gas emissions from commercial and residential buildings.
    • Intended to support some or all of the following use cases:
      • Advance testing of new API versions/functionality during the Beta periods preceding February and August Live releases.
      • Early-stage development and end-to-end testing of Portfolio Manager integrations before requesting access to the LIVE environment.
      • Development and testing of new or enhanced functionalities within the API user's software platform (beyond updates necessitated by EPA schema changes).
    • Optional Multifactor Authentication (MFA) will be available (similar to the functionality launched in the Live user interface on October 15, 2024).
    • Certain services were previously available as part of the TEST API only, due to the lack of a Test UI. With the launch of the Test UI the following services will no longer be necessary as workarounds in the TEST API and will be removed. Use of these calls after December 8, 2024 will result in 404 errors being returned:
      • Account Creation
        • POST /account
      • Simulating Connection/Share Requests
        • PUT /account/customFieldList/recipient/(dxAccountId)
        • POST /invite/account/(dxAccountId)
        • POST /invite/account/(dxAccountId)/meter/(meterId)
        • POST /invite/account/(dxAccountId)/property/(propertyId)
        • PUT /meter/(meterId)/customFieldList/recipient/(dxAccountId)
        • PUT /property/(propertyId)/customFieldList/recipient/(dxAccountId)

 

  • Tracking renewable natural gas percentage
    • New fields will be defined to indicate whether a natural gas meter is "renewable" and to track the percent of renewable natural gas for each consumption record.
    • The new inputs will not be usable until a future release, after which point they will be used to calculate the percentage of renewable natural gas being used in the operation of a property.
    • This is a late-breaking addition to the 24.0 release items; further details will be added to this FAQ and discussed during the December 11, 2024 Beta Release webinar.

 

  • Planned enhancements for the Portfolio Manager web services 24.0 Live release on February 24, 2025 (not available as part of the Beta release on December 9, 2024)
    • A new metric, "Source EUI Appears High/Low," will be added to indicate whether a property appears to use a large/small amount of energy relative to its property type and size.

Was this article helpful?