Web Services

  1. General Web Services Integration Questions
  2. After I apply for access to the web services LIVE environment as a data exchange provider, will my customers also need to apply for LIVE access for their individual accounts?
  3. Are there web services that can help me find out why my property is not receiving a score?
  4. Can I use the same account to run web services in both the test environment and LIVE environment?
  5. Can my current Portfolio Manager data be copied into the test web services account for testing purposes?
  6. Can the data in my test web services account be rolled over into my live Portfolio Manager account?
  7. Can you provide the live production URL?
  8. Do the Portfolio Manager web services accept any language other than English?
  9. Do you have any estimated maximum time for REST responses? Do you have a suggested timeout length?
  10. How can I create a space revision history for my property, building, or property use using web services? The API only allows one value for gross floor area.
  11. How do I display ENERGY STAR metrics in my software?
  12. More...
  1. Account Web Services
  2. A customer list is available through the “GET /customer/list ”service, but could customer lists be made available as a downloadable report through the web services GUI tab in the new Portfolio Manager?
  3. After I apply for access to the web services LIVE environment as a data exchange provider, will my customers also need to apply for LIVE access for their individual accounts?
  4. Can you explain the customer account creation process in the web services?
  5. Could you explain the difference between “account” services and “customer” services?
  6. How do you delete a customer in the test environment?
  7. I am trying to add customField to a connection request. How do I do this?
  8. I can't seem to get the /mapping/customer/(espCustID) method working properly. Why?
  9. I get an error when trying to submit data for custom fields. How do I set up and simulate a customer submission of data for custom fields?
  10. In the previous web services (ABS 2.5), it was possible to create a building and mark the owner as a NEW PM user. Is this feature available in the new REST-based services?
  11. The only service that will currently allow a user to obtain a customer’s Portfolio Manager user name is “GET /customer/(customerId)”. Could a customer’s user name be included in “GET /customer/list” and/or “GET /connect/account/pending/list,” which appear to only include the customer’s numerical accountID?
  12. More...
  1. Connection/Share Web Services
  2. How do I set up a connection with my customers in Portfolio Manager to enable us to share and exchange data?
  3. I don’t see a Portfolio Manager login username (espCustID) when retrieving my pending customer account list. How do I map this customer to my existing espCustId?
  4. I get an error when trying to submit data for custom fields. How do I set up and simulate a customer submission of data for custom fields?
  5. I get an error when trying to use POST /invite/account/(dxAccountId). How do I simulate a connection request from a customer?
  6. I have shared my property with a data exchange provider, and now I am unable to share the property with other data exchange providers. Why is this?
  7. If I share a data center meter directly, without sharing the property, how do I know which data center the meter belongs to?
  8. Is it possible for a user, once connected, to unshare their account, in addition to the property and meter levels? If so, then how will web service provider be notified?
  9. Is there a web service that returns a list of accounts with which an individual property or meter has been shared?
  10. The example response in the API documentation for “GET /share/meter/pending/list” shows a field for meter number, but when I run the method I don’t see this field?
  11. The GET/notification/list API page only shows an example response for a meter and property-level “unshare.” Can you provide an example XML response for what you would see when a customer disconnects sharing at the account level?
  12. More...
  1. Property Web Services
  2. Are there web services that can help me find out why my property is not receiving a score?
  3. Can a building be associated with another building as a "sibling" not as parent-child?
  4. For federal properties, there are additional attributes required, including Agency ID and Federal Real Property ID. What are these IDs, and how can I obtain them?
  5. How are the current ‘uniqueBuildingIdentifier’ fields being converted in the new system?
  6. How do I know which unique identifier will hold the "otherFederalPropertyId" value?
  7. How do we associate multiple property uses to a property?
  8. How is the “CustomFieldList” defined and used? Are these similar to the current custom data fields?
  9. Is there a list of all Portfolio Manager data validations not represented in the XML schemas?
  10. What does the “occupancyPercentage” field in the property.xsd represent? How do I calculate occupancy percentage?
  11. What is the “constructionStatus” field in the property.xsd for?
  12. More...
  1. Building Web Services
  2. Am I required to create buildings within a property?
  3. Are there web services that can help me find out why my property is not receiving a score?
  4. Can a building be associated with another building as a "sibling" not as parent-child?
  5. How are buildings different from property uses (propertyUse)?
  1. Property Use Web Services
  2. How do I delete a property use detail?
  3. How do I update property use details?
  4. How do property use default values work?
  5. How do we associate multiple property uses to a property?
  6. How do you create a data center meter on a data center property use?
  7. I am having trouble with the "singleStore" value in the property use schemas. Is this value required and what are the options?
  8. If I share a data center meter directly, without sharing the property, how do I know which data center the meter belongs to?
  9. My property use is displaying attributes that I did not submit. What happened?
  10. Some property uses, like a K-12 school, have the attributes PercentCooled and PercentHeated. The data type for these attributes seems to have changed from a number to a string. How was this handled in the upgrade?
  11. The parking.xsd schema indicates that required fields for parking seem to have changed. There is a new data field for “Supplemental Heating,” and the current field “Weekly Hours of Access” seems to have been dropped. Can you confirm if these fields are or are not needed for parking spaces in the upgraded Portfolio Manager?
  12. More...
  1. Meter Web Services
  2. Can multiple custom fields be created at once using the customFieldList attribute?
  3. How do I replace or retire a meter using the API? Should I use the delete method to de-associate the meter?
  4. How do the new meter services handle the following meter types: district chilled water, electric, steam, and other?
  5. How do we perform a “replace range” for meter consumption in the new web services?
  6. How do you create a data center meter on a data center property use?
  7. How is the “CustomFieldList” defined and used? Are these similar to the current custom data fields?
  8. How is the meter 'firstBillDate' determined?
  9. If I create a meter on a property using /property/(propertyId)/meter, do I need to explicitly associate it to the property again? What is the purpose of /association/property/(propertyId)/meter?
  10. Is it possible to associate a single meter to multiple properties?
  11. Is there a list of valid property-level energy meter types and unit of measure combinations?
  12. More...
  1. Reporting Web Services
  2. Are “change from baseline” metrics included in the current reporting services?
  3. Are Heating Degree Days (HDD) and Cooling Degree Days (CDD) available via web services? What method will be used to retrieve that information?
  4. Are there web services that can help me find out why my property is not receiving a score?
  5. Do reporting services provide a breakdown of site energy use by type, as is currently available on the Statement of Energy Performance?
  6. Does the new Portfolio Manager provide ENERGY STAR scores for Canadian buildings?
  7. Our customers would like ENERGY STAR scores for each of their buildings. What do we do with property uses that aren't eligible for scores?
  8. The metrics sourceIntensityScore50 and sourceIntensityScore75 have been removed from the Web Services Reporting API section. Will these metrics be replaced?
  9. There's a distinction between buildings (properties) and a campus of buildings (associating a property to another property). In the new Portfolio Manager, properties are eligible for ENERGY STAR scores. Are campuses (i.e., aggregates of properties) also eligible for scores?
  10. When I generate metrics for a parent property (campus), are the meters from associated sub-properties (buildings) automatically included in calculations? If not, how can I include the sub-properties?
  1. Target Finder Web Services
  2. Are there web services available for Target Finder?
  3. How do I use the new design functionality to retrieve design metrics?
Welcome Guest