GET List Demand Response

URL: /demandResponse

Accessible by: Utility accounts only.

Returns a list of all demand response event which have been issued and have not yet expired.

Request Properties

Property	Version	Type	Required	Description
operation	1	String	Yes	The type of request. Always "list".

Response Properties

Property	Version	Type	Description
drList	1	DemandResponse []	The list of demand responses which have not yet expired.
status	1	Status	The api response code.

Example Request:

Request Body

NOTE: Request body is not encoded for example purposes.

HEADERS:
	Content-Type: application/json;charset=UTF-8
	Authorization: Bearer Rc7JE8P7XUgSCPogLOx2VLMfITqQQrjg
	
REQUEST:
	GET https://api.ecobee.com/1/demandResponse?format=json&body={"operation":"list"}

Sample API Call

Show code sample in:

curl -s -H 'Content-Type: text/json' -H 'Authorization: Bearer ACCESS_TOKEN' 'https://api.ecobee.com/1/demandResponse?format=json&body=\{"operation":"list"\}'

					
$.ajax({
    beforeSend: function(request) {
        request.setRequestHeader("Authorization", "Bearer ".concat(ACCESS_TOKEN));
    },
    dataType: "json",
    url: 'https://api.ecobee.com/1/demandResponse?format=json&body=\{"operation":"list"\}',
    success: function(data) {
    	var response = JSON.stringify(data, null, 4);
    }
});

Example Response:

{
    "drList": [
        {
            "name": "dr-1",
            "demandResponseRef": "8f6b11407903a4d0800033",
            "comments": "",
            "message": "alert",
            "deferredDate": "2001-01-01",
            "deferredTime": "12:34:56",
            "showIdt": true,
            "showWeb": true,
            "sendEmail": false,
            "randomizeStartTime": false,
            "randomStartTimeSeconds": 1800,
            "randomizeEndTime": true,
            "randomEndTimeSeconds": 1800,
            "event": {
                "type": "demandResponse",
                "name": "dr-1",
                "startDate": "2013-08-13",
                "startTime": "13:50:32",
                "endDate": "2013-08-13",
                "endTime": "20:50:32",
                "isOccupied": false,
                "isCoolOff": false,
                "isHeatOff": true,
                "coolHoldTemp": 780,
                "heatHoldTemp": 700,
                "fan": "auto",
                "vent": "off",
                "ventilatorMinOnTime": 5,
                "isOptional": true,
                "isTemperatureRelative": false,
                "coolRelativeTemp": 0,
                "heatRelativeTemp": 0,
                "isTemperatureAbsolute": false,
                "dutyCyclePercentage": 255,
                "fanMinOnTime": 0,
                "occupiedSensorActive": false,
                "unoccupiedSensorActive": false,
                "drRampUpTemp": 3600,
                "drRampUpTime": 3600,
                "linkRef": "testLink1"
            },
            "thermostats": [
                "123456789012",
                "123456789013",
                "123456789014"
            ]
        },
        {
            "name": "dr-2",
            "demandResponseRef": "8f6b11407903a4d0800034",
            "comments": "",
            "message": "alert",
            "deferredDate": "2001-01-01",
            "deferredTime": "12:34:56",
            "showIdt": true,
            "showWeb": true,
            "sendEmail": false,
            "randomizeStartTime": false,
            "randomStartTimeSeconds": 1800,
            "randomizeEndTime": true,
            "randomEndTimeSeconds": 1800,
            "event": {
                "type": "demandResponse",
                "name": "dr-2",
                "startDate": "2013-08-13",
                "startTime": "20:50:32",
                "endDate": "2013-08-13",
                "endTime": "23:50:32",
                "isOccupied": false,
                "isCoolOff": false,
                "isHeatOff": true,
                "coolHoldTemp": 780,
                "heatHoldTemp": 700,
                "fan": "auto",
                "vent": "off",
                "ventilatorMinOnTime": 5,
                "isOptional": true,
                "isTemperatureRelative": false,
                "coolRelativeTemp": 0,
                "heatRelativeTemp": 0,
                "isTemperatureAbsolute": false,
                "dutyCyclePercentage": 255,
                "fanMinOnTime": 0,
                "occupiedSensorActive": false,
                "unoccupiedSensorActive": false,
                "drRampUpTemp": 3600,
                "drRampUpTime": 3600,
                "linkRef": "testLink1"
            },
            "thermostats": [
                "123456789012",
                "123456789013",
                "123456789014"
            ]
        }
    ],
    "status": {
        "code": 0,
        "message": ""
    }
}