Web Service Documentation / Release Notes

Release Notes for Test Environment (Version 10.0)

Release Number Date Description
10.0 Dec 11, 2017

Portfolio Manager Web Services 10.0 (beta) released to the Test environment.

9.0 Jun 12, 2017

Portfolio Manager Web Services 9.0 (beta) released to the Test environment.

8.0 Dec 12, 2016

Portfolio Manager Web Services 8.0 (beta) released to the Test environment.

7.0.1 Jun 27, 2016 The following issues have been resolved: 8894
7.0 Jun 13, 2016

Portfolio Manager Web Services 7.0 (beta) released to the Test environment.

6.0 Dec 7, 2015

Portfolio Manager Web Services 6.0 (beta) released to the Test environment.

5.0 Jun 8, 2015

Portfolio Manager Web Services 5.0 (beta) released to the Test environment.

4.0 Dec 10, 2014

Portfolio Manager Web Services 4.0 (beta) released to the Test environment.

3.0 Jun 4, 2014

Portfolio Manager Web Services 3.0 (beta) released to the Test environment.

2.0 Dec 10, 2013

Portfolio Manager Web Services 2.0 (beta) released to the Test environment.



Release Notes for Live Environment (Version 9.0)

Release Number Date Description
9.2 Oct 9, 2017

This release involved fixes specifically for the web application and not web services.

9.1 Sep 7, 2017

This release involved various fixes specifically for the web application.

The following new metrics were also added. Please see the Full List of Reporting Metrics for the corresponding web service metric names.

  • Alert - Energy Meter has less than 12 full calendar months of data
  • Alert - Energy Meter has gaps
  • Alert - Energy Meter has overlaps
  • Alert - Energy - No meters selected for metrics
  • Alert - Energy Meter has single entry more than 65 days
  • Alert - Water Meter has less than 12 full calendar months of data
  • Alert - Water Meter has gaps
  • Alert - Water Meter has overlaps
  • Alert - Water - No meters selected for metrics
  • Alert - Waste Meter has less than 12 full calendar months of data
  • Alert - Waste Meter has gaps
  • Alert - Waste Meter has overlaps
  • Alert - Waste - No meters selected for metrics
The following metrics have been removed.
  • Alert- Meter has gaps
  • Alert- Meter has less than 12 full calendar months of data
  • Alert- No associations are set up for the property
  • Alert- Individual monthly meter entry is more than 65 days long
  • Alert- Meter has overlaps

9.0 Aug 14, 2017

Portfolio Manager Web Services 9.0 released to the Live environment.

8.6 Jul 19, 2017 The following issues have been resolved: 9957
8.5.2 Jun 28, 2017

This release involved fixes specifically for the web application and not web services.

8.5.1 Jun 15, 2017

This release involved fixes specifically for the web application and not web services.

8.5 Jun 12, 2017

This release involved fixes specifically for the web application and not web services.

8.4 May 9, 2017

This release involved fixes specifically for the web application and not web services.

8.3 Apr 21, 2017 The following issues have been resolved: 9764
8.2 Mar 20, 2017

This release involved fixes specifically for the web application and not web services.

8.1 Mar 6, 2017 The following issues have been resolved: 9565
8.0 Feb 13, 2017

Portfolio Manager Web Services 8.0 released to the Live environment.

7.4 Jan 13, 2017

This release involved fixes specifically for the web application and not web services.

7.3.1 Nov 15, 2016

This release involved fixes specifically for the web application and not web services.

7.3 Oct 28, 2016

This release involved fixes specifically for the web application and not web services.

7.2.2 Sep 26, 2016

This release involved fixes specifically for the web application and not web services.

7.2.1 Sep 21, 2016

This release involved fixes specifically for the web application and not web services.

7.2 Sep 14, 2016 The following issues have been resolved: 9153
7.1 Aug 19, 2016

This release involved fixes specifically for the web application and not web services.

7.0 Aug 8, 2016

Portfolio Manager Web Services 7.0 released to the Live environment.

6.7 Jul 15, 2016

This release involved fixes specifically for the web application and not web services.

6.6 Jun 13, 2016

This release involved fixes specifically for the web application and not web services.

6.5 May 13, 2016 The following issues have been resolved: 7729
6.4 Apr 15, 2016

This release involved fixes specifically for the web application and not web services.

6.3 Mar 25, 2016

This release involved fixes specifically for the web application and not web services.

6.2 Mar 3, 2016

This release involved fixes specifically for the web application and not web services.

6.1.1 Feb 20, 2016

This release involved fixes specifically for the web application and not web services.

6.1 Feb 19, 2016

This release involved fixes specifically for the web application and not web services.

6.0.1 Feb 12, 2016

This release involved fixes specifically for the web application and not web services.

6.0 Feb 8, 2016

Portfolio Manager Web Services 6.0 released to the Live environment.

5.6.3 Jan 26, 2016

This release involved fixes specifically for the web application and not web services.

5.6.2 Jan 21, 2016

This release involved fixes specifically for the web application and not web services.

5.6.1 Jan 16, 2016

This release involved fixes specifically for the web application and not web services.

5.6 Jan 11, 2016

This release involved fixes specifically for the web application and not web services.

5.5 Dec 7, 2015

This release involved fixes specifically for the web application and not web services.

5.4.1 Nov 16, 2015

This release involved fixes specifically for the web application and not web services.

5.4 Nov 11, 2015

This release involved fixes specifically for the web application and not web services.

5.3 Oct 23, 2015 The following issues have been resolved: 3704.
5.2.2 Oct 15, 2015

This release involved fixes specifically for the web application and not web services.

5.2.1 Sep 30, 2015

This release involved fixes specifically for the web application and not web services.

5.2 Sep 24, 2015

This release involved fixes specifically for the web application and not web services.

5.1.2 Sep 15, 2015

This release involved fixes specifically for the web application and not web services.

5.1.1 Sep 4, 2015

This release involved fixes specifically for the web application and not web services.

5.1 Sep 1, 2015

This release involved fixes specifically for the web application and the following web service enhancement:

  • Target Finder Web Service now provides the option to specify the set of units for returned metrics
The following web service document is now available:
  • Full List of Portfolio Manager Alerts

5.0.3 Aug 18, 2015

This release involved fixes specifically for the web application and not web services.

5.0.2 Aug 7, 2015

This release involved fixes specifically for the web application and not web services. (Note that release 5.0.1 was intentionally skipped).

5.0 Aug 3, 2015

Portfolio Manager Web Services 5.0 released to the Live environment.

4.4 Jul 7, 2015

This release involved fixes specifically for the web application and not web services.

4.3.2 May 15, 2015

This release involved fixes specifically for the web application and not web services.

4.3.1 Apr 22, 2015 A new metric called "List of All Property Use Types at Property" has been added to the "Property Information" metric group.
4.3 Apr 9, 2015 The following web service documents have been updated (English only):
  • Introduction to Exchanging Data
  • Testing Web Services
4.2 Mar 25, 2015 The following issues have been resolved: 6998, 6929.

The following new change has also been released:
  • The Get Consumption Data web service can now be used to retrieve data by specifying an optional start and end date range. Please the API documentation for this web service for more details.
4.1 Mar 11, 2015 The following issues have been resolved: 4286, 4430.

The following web service documents have been updated (French only):
  • Testing Web Services
  • Connection and Sharing
4.0.2 Feb 25, 2015 The following issues have been resolved: 6930, 6933, 6952. (Note that release 4.0.1 was intentionally skipped).
4.0 Feb 10, 2015

Portfolio Manager Web Services 4.0 released to the Live environment.

The following issues have been resolved: 5626, 6662, 3198, 4641, 6871, 4108, 4049.

The following web service documents have been updated:

  • Connection and Sharing

3.8.1 Jan 22, 2015

This release involved fixes specifically for the web application and not web services.

3.8 Jan 15, 2015 The following issues have been resolved: 5626, 6662, 3198.
3.7.2 Dec 18, 2014

This release involved fixes specifically for the web application and not web services.

3.7.1 Dec 11, 2014

This release involved fixes specifically for the web application and not web services.

3.7 Dec 10, 2014

This release involved fixes specifically for the web application and not web services.

3.6 Nov 13, 2014 The following issues have been resolved: 6482.
3.5.2 Nov 4, 2014

This release involved fixes specifically for the web application and not web services.

3.5.1 Oct 30, 2014

This release involved fixes specifically for the web application and not web services.

3.5 Oct 28, 2014

This release involved fixes specifically for the web application and not web services.

3.4 Oct 8, 2014 The following issues have been resolved: 5889.

The following new changes have also been released:
  • The list of reporting metrics have been updated for the "Energy Use by Fuel Source" and "Cost Performance Metrics" metric groups.
  • New metrics "Property Data Administrator - Account ID" and "Shared by Contact - Account ID" have been added to the "Property Information" metric group.
3.3.1 Sep 24, 2014

This release involved fixes specifically for the web application and not web services.

3.3 Sep 16, 2014

This release involved fixes specifically for the web application and not web services.

3.2.1 Sep 5, 2014

This release involved fixes specifically for the web application and not web services.

3.2 Sep 3, 2014

The following issues have been resolved: 6020, 6285.

The following web service documents (French only) have been updated:

  • Connection and Sharing

3.1.2 Aug 26, 2014 The following issues have been resolved: 6253.
3.1.1 Aug 19, 2014

This release involved fixes specifically for the web application and not web services.

3.1 Aug 12, 2014

This release involved new sharing functionality, which included a number of changes to the web application and a handful of business rule changes that affect web services:

  • Share Forward - Ability to share a property that has been shared with you.
  • Transfer/Disconnect with Shares - Ability to maintain shared meters or properties even if you disconnect form a customer, if they disconnect from you, or if they transfer ownership of their property to someone else.
  • Streamlined Share Edits - When someone shares a new meter with you or removes access to a single meter, you will not have to "re-accept" the share for the property or the other meters.
For further details, please reference the Connection and Sharing document from the home page.

3.0 Aug 6, 2014

Portfolio Manager Web Services 3.0 released to the Live environment.

The following issues have been resolved: 5188, 5345, 5627.

2.9 Jul 21, 2014 The following issues have been resolved: 5551.
2.8 Jun 24, 2014 The following issues have been resolved: 5995.
2.7.1 Jun 18, 2014

This release involved fixes specifically for the web application and not web services.

2.7 Jun 16, 2014

This release involved fixes specifically for the web application and not web services.

2.6 Jun 4, 2014

This release involved fixes specifically for the web application and not web services.

2.5 May 28, 2014

This release involved fixes specifically for the web application and not web services.

2.4 May 12, 2014

This release involved fixes specifically for the web application and not web services.

2.3 Apr 22, 2014

The following issues have been resolved: 5610, 5578, 5543, 5536.

2.2.1 Apr 1, 2014

This release involved fixes specifically for the web application and not web services.

2.2 Mar 28, 2014

This release involved fixes specifically for the web application and not web services.

2.1.1 Mar 13, 2014

This release involved fixes specifically for the web application and not web services.

2.1 Feb 25, 2014

The following issues have been resolved: 4453, 5191.

The following web service documents (French only) have been updated:

  • Introduction to Exchanging Data
  • Testing Web Services
  • Connection and Sharing

2.0.1 Feb 12, 2014

This release involved fixes specifically for the web application and not web services.

The following web service documents (English only) have been updated:

  • Introduction to Exchanging Data
  • Testing Web Services
  • Connection and Sharing

2.0 Feb 10, 2014

Portfolio Manager Web Services 2.0 released to the Live environment.

The following issues have been resolved: 4679, 4664, 4548, 4546, 4511.

1.17 Feb 3, 2014

This release involved fixes specifically for the web application and not web services.

1.16 Jan 23, 2014

The following issues have been resolved: 5186.

1.15 Jan 9, 2014

The following issues have been resolved: 5125, 5102, 4589, 3856.

1.14.1 Jan 2, 2014

This release involved fixes specifically for the web application and not web services.

1.14 Dec 18, 2013

The following issues have been resolved: 5037, 4991, 3248

The following web service documents have been updated:

  • Connection and Sharing

1.13 Dec 5, 2013

The following issues have been resolved: 4130, 4879, 4956, 4946, 4888.

1.12.2 Nov 22, 2013

This release involved fixes specifically for the web application and not web services.

1.12.1 Nov 21, 2013

This release involved fixes specifically for the web application and not web services.

1.12 Nov 19, 2013

The following issues have been resolved: 4881, 4351.

1.11.1 Nov 14, 2013

This release involved fixes specifically for the web application and not web services.

1.11 Nov 7, 2013

The following issues have been resolved: 4838, 4839, 4697, 4358.

The following new functionality has been released:

  • Web Services Mailing List – If you exchange data via web service, you and your developers can stay informed of key changes that include defect fixes and system status alerts by subscribing to this mailing list. To access the mailing list, click on the "Subscribe to the Web Services Mailing List" link from the main web services documentation page.

1.10.1 Oct 30, 2013

The ENERGY STAR SSL certificate has been updated. Please make sure your web service client's security certificate repository is appropriately updated.

1.10 Oct 28, 2013

The following issues have been resolved: 4535

The following web service documentation updates have been made:

  • The URL to the list of Frequently Asked Questions has been changed.

1.9 Oct 21, 2013

The following issues have been resolved: 4732, 4693, 4772, 4537, 4251, 4408.

The following web service documents have been updated:

  • Connection and Sharing (French only)
  • Introduction to Exchanging Data
  • Transitioning from Automated Benchmarking (ABS) 2.5

1.8 Sep 25, 2013

This release involved fixes specifically for the web application and not web services.

1.7 Sep 22, 2013

The following issues have been resolved: 4645.

1.6 Sep 15, 2013

The following issues have been resolved: 4633, 4373, 4514.

The following web service documents have been updated:

  • Connection and Sharing (English only)
  • Introduction to Exchanging Data (French only)
  • Testing Web Services (French only)
  • Transitioning from Automated Benchmarking (ABS) 2.5 (French only)

1.5 Sep 3, 2013

This release involved fixes specifically for the web application and not web services.

1.4 Aug 29, 2013

The following issues have been resolved: 4369, 4492, 4403, 4393.

1.3 Aug 22, 2013

The following issues have been resolved: 4281, 4396, 4352.

The following new functionality has been released:

  • Error Code During Maintenance Release – During maintenance releases the web services will return a 502 error and not a 200 success code.

1.2 Aug 15, 2013

The following issues have been resolved: 4391, 4278.

1.1 Aug 9, 2013

The following issues have been resolved: 4355.

1.0.8 Aug 2, 2013

The following issues have been resolved: 4267, 4347.

1.0.7 Aug 1, 2013

The following issues have been resolved: 4268.

1.0.6 Jul 31, 2013

The following issues have been resolved: 4290, 4245.

1.0.5 Jul 30, 2013

This release involved fixes specifically for the web application and not web services.

1.0.4 Jul 29, 2013

The following issues have been resolved: 4250, 3943, 4219, 4295, 4232, 4292, 4233, 4219.

1.0.3 Jul 23, 2013

The following issues have been resolved: 4229, 4234, 4238, 4247, 4254, 4214.

1.0.2 Jul 19, 2013

This release involved fixes specifically for the web application and not web services.

1.0.1 Jul 18, 2013

This release involved fixes specifically for the web application and not web services.

1.0 Jul 17, 2013

The following issues have been resolved: 4050, 4103, 4074, 4064, 3517, 4058, 4054, 4053, 3977, 3837, 3756, 3748, 3395, 3323.

The following new functionality and updates have been released:
  • Set Baseline Dates and Performance Targets –Functionality to allow you to retrieve and set an energy and water baseline dates and performance target settings for a property is now available. Please see the "Miscellaneous" section of the "Property Services" API documentation and their corresponding XML schemas for details.

  • POST Consumption Data XML Response Change – When calling "POST /ws/meter/(meterId)/consumptionData" to add meter consumption data, the XML response schema now conforms to the meterConsumptionData.xsd instead of the response.xsd XML schema. This change allows a unique identifier to easily be associated to each newly added meter consumption record.

  • More Expanded Set of Metrics – A more expanded set of metrics is now available in the Get-Metrics and Get-Design-Metrics web services. Please see the "Reporting Services" API documentation for details.
0.4 May 22, 2013

The following issues have been resolved: 3758, 3372, 3348.

The following new functionality has been released:

  • Weather Data Updates – Weather data is now available for March and April 2013. You will now be able to receive ratings for those corresponding period ending dates.

  • Energy Performance Projects – Functionality to track the upgrades and changes made to your property in an effort to improve energy performance is now available. Please see the "Property Services" API documentation and their corresponding XML schemas for details.

  • Property Use and Characteristic Updates – The college/university property-use type refers to "numberOfFTEWorkers" instead of "numberOfFullTimeEmployees". The supermarket property-use type now refers to "numberOfComputers".

  • County Information – County can now be tracked as an optional data element for a property. Please see the property XML schema for details.

  • Expanded Set of Metrics – A more expanded set of metrics is now available in the Get-Metrics and Get-Design-Metrics web services. Please see the "Reporting Services" API documentation for details.

  • "id" Attribute Included in GET Links – The web services that return a list of GET links now include an "id" attribute within each GET link. The "id" attribute indicates the Portfolio Manager unique identifier for the corresponding entity.

  • Updates to List of Primary Function Types and Countries – The list of primary function types in the property XML schema and the list of supported countries have been updated.

  • Federal Agency Updates – When designating a property as a federal agency, you will now have to specify the country that owns the federal agency.

  • Miscellaneous updates to schema annotations.

0.3 Mar 21, 2013

The following issues have been resolved: 3263, 3249, 3244, 3201, 3182, 3123, 3130, 2877, 2870, 2642, 2889.

The following new functionality has been released:

  • Weather Data Updates – Weather data is now available for March and April 2013. You will now be able to receive ratings for those corresponding period ending dates.

  • Default Value Support – Functionality to manage default values for property-use details is now available. This includes specifying the use of default values when updating use characteristics as well as being able to distinguish which use characteristics are using default values when retrieving them. Please see the "Property Use Services" API documentation and their corresponding XML schemas for details.

0.2 Dec 12, 2012

The following issues have been resolved: 2305, 2565, 2600, 2655, 2719, 2721.

The following new functionality has been released:

  • Target Finder – A web service is now available to retrieve metrics that allow you to estimate how much energy your property would need to consume annually to reach your design energy goal, or conversely, determine the ENERGY STAR score that would be associated with your design estimated energy consumption. Please see the Target Finder Services category of the API documentation for more information.

  • Design Services – A set of web services are now available to allow you to manage the design characteristics of your property. Please see the Design section of the API documentation under the Property Services category for more information. Also, another web service is now available for you to retrieve metrics based on your property's design. For more information on this web service, please see the Reporting Services category of the API documentation for more information.

  • Water Meter Association – The existing set of web services that manage the association of energy meters to a property have been enhanced to handle the management of water meters. Please see the Property Meter Association section of the API documentation for the Meter Services for more information.

0.1.3 Oct 23, 2012 The following issues have been resolved: 2554, 2560.
0.1.2 Oct 15, 2012 The following issues have been resolved: 2365, 2452.
0.1.1 Sep 30, 2012 The following issues have been resolved: 2418.
0.1.0 Sep 27, 2012 Initial release.