POST V1/Benchmarking.{ext}/SiteAttributes

This API used to post the site attributes data to Energy Star.
Mandatory Fields : All properties of ManageSiteAttributes.
Optional Fields : N/A.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ext

Which media types are acceptable for the response, such as json/xml

If no matches are found, the content negotiator tries to match on the media type of the request body, if any. For example, if the request contains JSON data, the content negotiator looks for a JSON formatter.

string

Content-Type: application/json OR application/xml

Body Parameters

Site Attributes

EMS.Benchmarking.Entities.ManageSiteAttributes
NameDescriptionTypeAdditional information
ESSiteId

ESSite Id

string

None.

BuildingTypeId

Building Type Id

string

None.

EffectiveDate

Effective Date

string

None.

YearBuilt

Year Built

string

None.

FacilityName

Facility Name

string

None.

Status

Status

string

None.

BuildingAddress

BuildingAddress

string

None.

City

City

string

None.

State

State

string

None.

Zip

Zip

string

None.

BuildingAttributesList

Site Building Attributes List

Collection of EMS.Benchmarking.Entities.BuildingAttributesForSites

None.

Request Formats

application/json, text/json

Sample:
{
  "esSiteId": "sample string 1",
  "buildingTypeId": "sample string 2",
  "effectiveDate": "sample string 3",
  "yearBuilt": "sample string 4",
  "facilityName": "sample string 5",
  "status": "sample string 6",
  "buildingAddress": "sample string 7",
  "city": "sample string 8",
  "state": "sample string 9",
  "zip": "sample string 10",
  "buildingAttributesList": [
    {
      "buildingTypeAttributeId": "sample string 1",
      "buildingTypeAttributeValue": "sample string 2",
      "effectiveDate": "sample string 3"
    },
    {
      "buildingTypeAttributeId": "sample string 1",
      "buildingTypeAttributeValue": "sample string 2",
      "effectiveDate": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:
<ManageSiteAttributes xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EMS.Benchmarking.Entities">
  <BuildingAddress>sample string 7</BuildingAddress>
  <BuildingAttributesList>
    <BuildingAttributesForSites>
      <BuildingTypeAttributeId>sample string 1</BuildingTypeAttributeId>
      <BuildingTypeAttributeValue>sample string 2</BuildingTypeAttributeValue>
      <EffectiveDate>sample string 3</EffectiveDate>
    </BuildingAttributesForSites>
    <BuildingAttributesForSites>
      <BuildingTypeAttributeId>sample string 1</BuildingTypeAttributeId>
      <BuildingTypeAttributeValue>sample string 2</BuildingTypeAttributeValue>
      <EffectiveDate>sample string 3</EffectiveDate>
    </BuildingAttributesForSites>
  </BuildingAttributesList>
  <BuildingTypeId>sample string 2</BuildingTypeId>
  <City>sample string 8</City>
  <ESSiteId>sample string 1</ESSiteId>
  <EffectiveDate>sample string 3</EffectiveDate>
  <FacilityName>sample string 5</FacilityName>
  <State>sample string 9</State>
  <Status>sample string 6</Status>
  <YearBuilt>sample string 4</YearBuilt>
  <Zip>sample string 10</Zip>
</ManageSiteAttributes>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.

Response Information

Resource Description

EMSResponseOfEMS.Common.TransactionResult
NameDescriptionTypeAdditional information
ResponseType

No description available

string

None.

Response

No description available

EMS.Common.TransactionResult

None.

Error

No description available

EMS.Common.Error

None.

Response Formats

application/json, text/json

Sample:
{
  "responseType": "TransactionResult",
  "response": {
    "status": "sample string 1",
    "message": "sample string 2",
    "result": "sample string 3"
  },
  "error": {
    "errorCode": "sample string 1",
    "errorDescription": "sample string 2"
  }
}

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.