Dr events

List the demand response events

get
Authorizations
Responses
200

successful operation

application/json
get
GET //dr/dr-events HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*
200

successful operation

{
  "events": [
    {
      "priority": "low",
      "name": "text",
      "startDate": "2025-09-16T12:44:29.381Z",
      "notificationDate": "2025-09-16T12:44:29.381Z",
      "notificationSent": true,
      "endDate": "2025-09-16T12:44:29.381Z",
      "goal": "text",
      "participants": [
        "text"
      ]
    }
  ]
}

Creates a new demand response event

post
Authorizations
Body

Refer to the /schemas/dr-event endpoint for the full JSON Schema definition

prioritystring · enumRequiredPossible values:
namestringRequired
startDatestring · date-timeRequired
notificationDatestring · date-timeRequired
notificationSentbooleanOptional
endDatestring · date-timeRequired
goalstringRequired
participantsstring[]Required
Responses
200

successful operation

application/json
Responsestring

The event Id.

post
POST //dr/dr-events HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 216

{
  "priority": "low",
  "name": "text",
  "startDate": "2025-09-16T12:44:29.381Z",
  "notificationDate": "2025-09-16T12:44:29.381Z",
  "notificationSent": true,
  "endDate": "2025-09-16T12:44:29.381Z",
  "goal": "text",
  "participants": [
    "text"
  ]
}
200

successful operation

text

Gets the event given by eventId

get
Authorizations
Responses
200

successful operation

application/json
get
GET //dr/dr-events/{eventId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "type": "energy",
  "cause": "text",
  "priority": 1,
  "startDate": "2025-09-16T12:44:29.381Z",
  "dueDate": "2025-09-16T12:44:29.381Z",
  "endDate": "2025-09-16T12:44:29.381Z",
  "description": "text",
  "location": {
    "project": "text",
    "site": "text",
    "system": "text",
    "node": "text",
    "device": "text"
  },
  "notes": [
    {
      "noteDate": "2025-09-16T12:44:29.381Z",
      "note": "text"
    }
  ]
}

Modifies a demand response event given by eventId

put
Authorizations
Body

Refer to the /schemas/dr-event endpoint for the full JSON Schema definition

prioritystring · enumRequiredPossible values:
namestringRequired
startDatestring · date-timeRequired
notificationDatestring · date-timeRequired
notificationSentbooleanOptional
endDatestring · date-timeRequired
goalstringRequired
participantsstring[]Required
Responses
200

successful operation

application/json
Responsestring

The event Id.

put
PUT //dr/dr-events/{eventId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 216

{
  "priority": "low",
  "name": "text",
  "startDate": "2025-09-16T12:44:29.381Z",
  "notificationDate": "2025-09-16T12:44:29.381Z",
  "notificationSent": true,
  "endDate": "2025-09-16T12:44:29.381Z",
  "goal": "text",
  "participants": [
    "text"
  ]
}
200

successful operation

text

Deletes the event given by eventId

delete
Authorizations
Responses
200

successful operation

No content
delete
DELETE //dr/dr-events/{eventId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

No content
PreviousParticipantsNextDr notifications