Web Service Documentation / Categories / Basic Account Services

Basic Account Services

Account Services allow you to manage Portfolio Manager accounts. These services are divided into two sections. The first section includes services that allow you to create and manage your own account as well as accounts that belong to your customers. The second section includes services that allow you to manage advanced settings that define your service offerings, such as your terms and conditions, supported fuel types, custom fields, etc.

Accounts

Method REST URI * Description
GET /account Returns general information for your account.
POST /account Creates an account for the purposes of offering data exchange services.
PUT /account Updates your account.
GET /account/(accountId)/customFieldList Returns a list of custom fields and their values for a specific customer account.
POST /customer Creates an account for your customer and establishes a connection to your account.
GET /customer/(customerId) Returns general account information for a specific customer that you are connected to.
PUT /customer/(customerId) Updates an account for your customer that you are already connected to. Currently you can only change whether they are allowed to share meter data with others. This only applies to their meters that you manage.
GET /customer/list Returns a list of customers that you are connected to.
GET /mapping/customer/(espCustID) Returns the identifier used within Portfolio Manager for a customer account based on a specified espCustID from the legacy Automated Benchmarking System (ABS) 2.5 system in place prior to June 2013.

Advanced Settings for Organizations Exchanging Data

Method REST URI * Description
GET /dataExchangeSettings Returns the settings that define your data exchange service offerings.
PUT /dataExchangeSettings Updates the settings that define your data exchange service offerings.
POST /dataExchangeSettings/customField Creates a custom field. The custom field(s) you specify are used to collect additional data from your customer during the connection/share process.
GET /dataExchangeSettings/customField/(customFieldId) Returns information for a specified custom field. The custom field(s) you specify are used to collect additional data from your customer during the connection/share process.
PUT /dataExchangeSettings/customField/(customFieldId) Updates a specified custom field. The custom field(s) you specify are used to collect additional data from your customer during the connection/share process.
DELETE /dataExchangeSettings/customField/(customFieldId) Deletes a specified custom field. The custom field(s) you specify are used to collect additional data from your customer during the connection/share process.
GET /dataExchangeSettings/customField/list Returns a list of custom fields that you have defined for your account. The custom field(s) you specify are used to collect additional data from your customer during the connection/share process.

* For the TEST environment, relative to the base URI:  https://portfoliomanager.energystar.gov/wstest

** Web services are only available in the TEST environment to simulate sharing process.

TEST