Utility Billing Data Set List API

The Utility Billing Data Set List API provides Green Building Studio client developers a method to determine the name and id of any utility billing history data sets uploaded to a given project. This information is needed in order to submit a Green Building Studio run using a utility data set instead of using project defaults for energy cost and weather.

Making The Request

To access the utility billing data set list API, use:

https://gbs.autodesk.com/gbs/api/v1/project/utilityDataSets/projectId/responseFormat

where projectId is the id of the project for which a list of utility data sets is desired. The user identified by the access token must have rights to view the projectId requested.

responseFormat may be either of the following values:

json indicates output in JavaScript Object Notation (JSON)

xml indicates output as XML

Note: If responseFormat is omitted, the output will default to XML.

Utility Billing Data Set List API Responses

The response from the API includes:

HistoryBillDataId - this value is an alphanumeric string representation of a guid.
Name - this value is the alphanumeric string name identified assigned by the user/client when the utility billing data set was uploaded to the project.

Responses are returned in the format indicated in the responseFormat within the request URL.

JSON Output Format

[{"HistoryBillDataId": "70743289-ade7-40c5-a571-87836f87de69", "Name": "Utility Data Beginning June 2011"}]

XML Output Example

<ArrayOfUtilityDataSetInfoItem>
       <UtilityDataSetInfoItem>
          <HistoryBillDataId>66a178c3-2c58-4c66-ae97-b65512745dda</HistoryBillDataId>
          <Name>2011 Utility Data Set</Name>
       </UtilityDataSetInfoItem>
</ArrayOfUtilityDataSetInfoItem>

Note: In the case where there are no utility billing history data sets for the given project an empty list is returned in the format specified by reponseFormat .