What changes will be made as part of the August 2025 web services 25.0 release?

The Beta release of the Portfolio Manager web services 25.0 schemas will be available to the public on June 30, 2025. The Live release will be available to the public on August 25, 2025. During this interim period, the web services TEST environment will be running 25.0 while the LIVE environment will be running 24.0.

This release will not be accompanied by an announcement email and webinar. Please closely review the details of this FAQ to ensure all necessary changes are implemented in your API integration in advance of the live release on August 25, 2025.

Planned enhancements for the Portfolio Manager web services 25.0 Beta release on June 30, 2025 and Live release on August 25, 2025

• New “College/University” score model for Canadian buildings
  • Score Updates
    • U.S. “College/University” properties remain ineligible to receive the 1-100 score.
    • New Canadian scores will be available for "College/University" property types. These properties were updated.
  • New Use Details Available for both US and Canadian Properties
    • Number of Full Time Students Enrolled (September – December)
      • Web services name: numberOfFullTimeStudentsEnrolledSeptemberToDecember
    • Number of Full Time Students Enrolled (January – April)
      • Web services name: numberOfFullTimeStudentsEnrolledJanuaryToApril
    • Number of Full Time Students Enrolled (May – August)
      • Web services name: numberOfFullTimeStudentsEnrolledMayToAugust
    • Annual Research Expenditure
      • Web services name: annualResearchExpenditure
    • Percent Floor Area That is Laboratory
      • Web services name: percentOfLabFloorArea
    • Highest Level of Award
      • Web services name: highestAwardLevel
    • Percent That Can Be Cooled
      • Web services name: percentCooled
    • Percent That Can Be Heated
      • Web Services name: percentHeated
  • Backfill for existing “College/University” property uses for values that do not exist
    • U.S. “College/University”

Use Detail	Backfill Value	Mark as Default?
Number of Full Time Students Enrolled (September – December)	Based on default density of 6.7 students for every 1,000 sqft of GFA entered	Yes
Number of Full Time Students Enrolled (January – April)	Based on default density of 6.7 students for every 1,000 sqft of GFA entered	Yes
Number of Full Time Students Enrolled (May – August)	Based on default density of 2.1 students for every 1,000 sqft of GFA entered	Yes
Annual Research Expenditure	“Less than 2.5 million”	Yes
Percent Floor Area That is Laboratory	10	Yes
Highest Level of Award	“Other program less than 2 years”	Yes
Percent That Can Be Cooled	100	Yes
Percent That Can Be Heated	100	Yes

• • • Canadian “College/University”. 

Use Detail	Backfill Value	Mark as Default?
Number of Full Time Students Enrolled (September – December)	Based on default density of 6.7 students for every 1,000 sqft of GFA entered	Yes
Number of Full Time Students Enrolled (January – April)	Based on default density of 6.7 students for every 1,000 sqft of GFA entered	Yes
Number of Full Time Students Enrolled (May – August)	Based on default density of 2.1 students for every 1,000 sqft of GFA entered	Yes
Annual Research Expenditure	“Less than 2.5 million”	Yes
Percent Floor Area That is Laboratory	10	Yes
Highest Level of Award	“Other program less than 2 years”	Yes
Percent That Can Be Cooled	100	Yes
Percent That Can Be Heated	100	Yes

• • 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:
    • collegeUniversityNumberOfFullTimeStudentsEnrolledSeptemberToDecember
    • collegeUniversityNumberOfFullTimeStudentsEnrolledJanuaryToApril
    • collegeUniversityNumberOfFullTimeStudentsEnrolledMayToAugust
    • collegeUniversityAnnualResearchExpenditure
    • collegeUniversityPercentOfLabFloorArea
    • collegeUniversityHighestAwardLevel
    • collegeUniversityPercentThatCanBeCooled
    • collegeUniversityPercentThatCanBeHeated
    • collegeUniversityNumberOfFullTimeStudentsEnrolledSeptemberToDecemberDensity
    • collegeUniversityNumberOfFullTimeStudentsEnrolledJanuaryToAprilDensity
    • collegeUniversityNumberOfFullTimeStudentsEnrolledMayToAugustDensity

• New “CEGEP” property type and score model for Canadian buildings (specifically for Quebec)
  • Score Updates
    • U.S. “CEGEP” properties will not be eligible to receive the 1-100 score.
    • New Canadian scores will be available for "CEGEP" property types.

• • New Use Details. Available for both US and Canadian Properties
    • • Gross Floor Area
        • Web services name: totalGrossFloorArea
      • Number of Full Time Students Enrolled (September – December)
        • Web services name: numberOfFullTimeStudentsEnrolledSeptemberToDecember
      • Number of Full Time Students Enrolled (January – April)
        • Web services name: numberOfFullTimeStudentsEnrolledJanuaryToApril
      • Number of Full Time Students Enrolled (May – August)
        • Web services name: numberOfFullTimeStudentsEnrolledMayToAugust
      • Annual Research Expenditure
        • Web services name: annualResearchExpenditure
      • Percent Floor Area That is Laboratory
        • Web services name: percentOfLabFloorArea
      • Highest Level of Award
        • Web services name: highestAwardLevel
      • Percent That Can Be Cooled
        • Web services name: percentCooled
      • Percent That Can Be Heated
        • Web Services name: percentHeated
      • Number of Full Time Equivalent (FTE) Workers
        • Web services name: numberOfFTEWorkers
      • Weekly Operating Hours
        • Web services name: weeklyOperatingHours
      • Enrollment
        • Web services name: enrollment
      • Number of Computers
        • Web services name: numberOfComputers
      • Grant Dollars
        • Web services name: grantDollars 
  • 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:
    • • cegepGrossFloorArea
      • cegepNumberOfFullTimeStudentsEnrolledSeptemberToDecember
      • cegepNumberOfFullTimeStudentsEnrolledJanuaryToApril
      • cegepNumberOfFullTimeStudentsEnrolledMayToAugust
      • cegepAnnualResearchExpenditure
      • cegepPercentOfLabFloorArea
      • cegepHighestAwardLevel
      • cegepPercentThatCanBeCooled
      • cegepPercentThatCanBeHeated
      • cegepComputerDensity
      • cegepEnrollment
      • cegepFullTimeEquivalentFteWorkersDensity
      • cegepGrantDollars
      • cegepNumberOfComputers
      • cegepFullTimeEquivalentFteWorkers
      • cegepWeeklyOperatingHours
      • cegepNumberOfFullTimeStudentsEnrolledSeptemberToDecemberDensity
      • cegepNumberOfFullTimeStudentsEnrolledJanuaryToAprilDensity
      • cegepNumberOfFullTimeStudentsEnrolledMayToAugustDensity
      • temporaryDataFlagCegep
      • designCegepGrossFloorArea

• New “Community Center and Social Meeting Hall” score model for Canadian buildings
  • Property Use Name Updates
    • The property use previously called "Social/Meeting Hall” will be renamed to "Community Center and Social Meeting Hall". Users should note, this change will impact API calls where you currently use the property use name: "Social/Meeting Hall". 

• • Score Updates
    • U.S. “Community Center and Social Meeting Hall” properties remain ineligible to receive the 1-100 score.
    • New Canadian scores will be available for "Community Center and Social Meeting Hall" property types. These properties were updated.

• • New Use Details Available for both US and Canadian Properties
    • Percent That Can Be Cooled
      • Web services name: percentCooled
    • Percent That Can Be Heated
      • Web Services name: percentHeated
  • Backfill for existing “Community Center and Social Meeting Hall” property uses for values that do not exist
    • U.S. “Community Center and Social Meeting Hall”

Use Detail	Backfill Value	Mark as Default?
Weekly Operating Hours	60	Yes
Workers On Main Shift	Based on default density of 0.93 workers for every 1,000 sqft of GFA entered	Yes
Percent That Can Be Cooled	100	Yes
Percent That Can Be Heated	100	Yes

• • • Canadian “Community Center and Social Meeting Hall”. Canadian users may observe artificially low ENERGY STAR Scores until these backfilled values are replaced with true values.

Use Detail	Backfill Value	Mark as Default?
Weekly Operating Hours	0	No
Workers On Main Shift	0	No
Percent That Can Be Cooled	0	No
Percent That Can Be Heated	0	No

• • 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:
    • communityCenterAndSocialMeetingHallPercentThatCanBeCooled
    • communityCenterAndSocialMeetingHallPercentThatCanBeHeated

• • Updates to existing web service metric names used in the Get-Use-Details-Metrics web service:
    • socialMeetingHallComputerDensity -> communityCenterAndSocialMeetingHallComputerDensity
    • socialMeetingHallGrossFloorArea -> communityCenterAndSocialMeetingHallGrossFloorArea
    • socialMeetingHallNumberOfComputers -> communityCenterAndSocialMeetingHallNumberOfComputers
    • socialMeetingHallNumberOfWorkersOnMainShift -> communityCenterAndSocialMeetingHallNumberOfWorkersOnMainShift
    • socialMeetingHallWeeklyOperatingHours -> communityCenterAndSocialMeetingHallWeeklyOperatingHours
    • socialMeetingHallWorkerDensity à communityCenterAndSocialMeetingHallWorkerDensity
    • temporaryDataFlagSocialMeetingHall -> temporaryDataFlagCommunityCenterAndSocialMeetingHall
    • designSocialMeetingHallGrossFloorArea -> designCommunityCenterAndSocialMeetingHallGrossFloorArea

• New “Fitness Center/Health Club/Gym” score model for Canadian buildings
  • Score Updates
    • U.S. “Fitness Center/Health Club/Gym” properties remain ineligible to receive the 1-100 score.
    • New Canadian scores will be available for "Fitness Center/Health Club/Gym" property types. These properties were updated.

• • New Use Details Available for both US and Canadian Properties
    • Percent That Can Be Cooled
      • • Web services name: percentCooled
      • Percent That Can Be Heated
        • Web Services name: percentHeated
  • Backfill for existing “Fitness Center/Health Club/Gym” property uses for values that do not exist
    • U.S. “Fitness Center/Health Club/Gym”

Use Detail	Backfill Value	Mark as Default?
Weekly Operating Hours	60	Yes
Workers On Main Shift	Based on default density of 0.93 workers for every 1,000 sqft of GFA entered	Yes
Percent That Can Be Cooled	100	Yes
Percent That Can Be Heated	100	Yes

• • • Canadian “Fitness Center/Health Club/Gym”. Canadian users may observe artificially low ENERGY STAR Scores until these backfilled values are replaced with true values.

Use Detail	Backfill Value	Mark as Default?
Weekly Operating Hours	0	No
Workers On Main Shift	0	No
Percent That Can Be Cooled	0	No
Percent That Can Be Heated	0	No

• • 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:
    • • fitnessCenterHealthClubGymPercentThatCanBeCooled
      • fitnessCenterHealthClubGymPercentThatCanBeHeated

• New “Bowling Alley” score model for Canadian buildings
  • Score Updates
    • U.S. “Bowling Alley” properties remain ineligible to receive the 1-100 score.
    • New Canadian scores will be available for "Bowling Alley" property types. These properties were updated.

• • New Use Details Available for both US and Canadian Properties
    • • Percent That Can Be Cooled
        • Web services name: percentCooled
      • Percent That Can Be Heated
        • Web Services name: percentHeated
  • Backfill for existing “Bowling Alley” property uses for values that do not exist
    • • U.S. “Bowling Alley”

Use Detail	Backfill Value	Mark as Default?
Weekly Operating Hours	60	Yes
Workers On Main Shift	Based on default density of 0.93 workers for every 1,000 sqft of GFA entered	Yes
Percent That Can Be Cooled	100	Yes
Percent That Can Be Heated	100	Yes

• • • • Canadian “Bowling Alley”. Canadian users may observe artificially low ENERGY STAR Scores until these backfilled values are replaced with true values.

Use Detail	Backfill Value	Mark as Default?
Weekly Operating Hours	0	No
Workers On Main Shift	0	No
Percent That Can Be Cooled	0	No
Percent That Can Be Heated	0	No

• • 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:
    • • bowlingAlleyPercentThatCanBeCooled
      • bowlingAlleyPercentThatCanBeHeated

• Various changes are being made to ENERGY STAR and NextGen certification metrics that can be queried via API. Users should note, these changes will impact any ENERGY STAR Certification eligibility and ENERGY STAR Certification year(s) metric calls that you currently have in place. 
  • Removal of the “ENERGY STAR Certification - Year(s) Certified” metric because the new “ENERGY STAR Certification - Year(s) Certified (Score)” metric added in the 24.0 Live release provides the same information.
    • User interface name: ENERGY STAR Certification - Year(s) Certified
    • Web services metric name: energyStarCertificationYears

• • Renamed the following metrics to provide clarity between ENERGY STAR and NextGen certifications
    • Eligible for Certification for Report PED (Y/N) -> Eligible for ENERGY STAR Certification for Report PED (Y/N)
      • No change needed for corresponding web service metric name
    • Eligible for Certification for Any PED (Y/N) -> Eligible for ENERGY STAR Certification for Any PED (Y/N)
      • No change needed for corresponding web service metric name
    • ENERGY STAR Certification - Next Eligible Date -> ENERGY STAR/NextGen Certification - Next Eligible Date
      • Web service metric name: energyStarCertificationNextEligibleDate -> energyStarNextGenCertificationNextEligibleDate
    • ENERGY STAR Certification - Application Status -> ENERGY STAR/NextGen Certification - Application Status
      • Web service metric name: energyStarCertificationApplicationStatus -> energyStarNextGenCertificationApplicationStatus
    • ENERGY STAR Certification - Last Approval Date -> ENERGY STAR/NextGen Certification - Last Approval Date
      • Web service metric name: energyStarCertificationLastApprovalDate -> energyStarNextGenCertificationLastApprovalDate

• Miscellaneous
  • Addition of kWh and Therms as unit of measures when managing Custom Use Details via API
  • Addition of eKWh as a unit of measure when managing “district” meters via API
    • Applies to the following “district” meter types: 
      • District Chilled Water - Absorption Chiller using Natural Gas
      • District Chilled Water - Electric-Driven Chiller
      • District Chilled Water - Engine-Driven Chiller using Natural Gas
      • District Chilled Water – Other
      • District Hot Water
      • District Steam
    • No new reporting metrics. Metrics will output as kBtu or GJ.
  • Removed the renewable natural gas flag (renewableNaturalGas) from the meter.xsd schema since it is no longer needed to track renewable natural gas percentage.
  • Corrected the “Durable assembled products-Other” enumeration value to “Durable assembled products - Other” in the XML schema so that there is leading and trailing space around the hyphen. This enumeration value is specific to the use detail plant type that belongs to “Manufacturing/Industrial Plant” property use. This correction is the permanent fix for known issue #16260.
• Enhancements for the 25.0 Live release (that are not available in the Beta release):
  • Annual updates to factors and reference data
    • EPA will be using the August release to implement annual updates to key factors and reference data underlying Portfolio Manager, which may include some or all of the following:
      • Thermal conversion factors
      • GHG emissions factors for plant-specific and regional electricity based on new eGRID data (www.epa.gov/egrid)
      • All other emissions factors
      • Default fuel cost data (as used in Target Finder and Design services)
      • Default fuel mix (as used in Target Finder and Design services)
      • Weather station mapping
      • Source energy conversion factors
      • National Median EUI values
    • All updates will be documented in the corresponding Technical Reference Documents, available at https://portfoliomanager.energystar.gov/pm/help . 

•  

•