Upload Utility Data API

The Upload Utility Data API provides Green Building Studio client developers a facility for submitting a utility data that will be used for simulation in a given project.

Making the request

To access the Upload Utility Data API, use:

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

where 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.

Request Method

POST

Parameters

• ProjectId : Id for project

  • Values: Integer
  • Required: Yes
• Name - Title for this utility data

  • Values: string
  • Required: Yes
• StartYear - start year of utility data

  • Values: integer
  • Required: Yes
• EndYear - end year of utility data

  • Values: integer
  • Required: Yes
• IsAllElectricBuilding
  • Values: boolean
  • Required: Yes
• ElecUsage - annual electric usage breakdown by month

  • Values: Array(UtilityItem)
  • Required: Yes
• FuelUsage - annual fuel usage breakdown by month

  • Values: Array(see UtilityItem)
  • Required: Yes
• ElecDemand - annual electric demand breakdown by month

  • Values: Array(see UtilityItem)
  • Required: Yes

Upload Utility Data Responses

Upload Utility Data API responses are returned in the format indicated in the responseFormat within the request URL.

JSON Output Example

113

XML Output Example

<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">113</int>