Dr events

List the demand response events

get

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Responses

200

successful operation

application/json

get

/dr/dr-events

HTTPcURLJavaScriptPython

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-12-16T02:22:10.731Z",
      "notificationDate": "2025-12-16T02:22:10.731Z",
      "notificationSent": true,
      "endDate": "2025-12-16T02:22:10.731Z",
      "goal": "text",
      "participants": [
        "text"
      ]
    }
  ]
}

Creates a new demand response event

post

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Body

application/json

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

/dr/dr-events

HTTPcURLJavaScriptPython

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-12-16T02:22:10.731Z",
  "notificationDate": "2025-12-16T02:22:10.731Z",
  "notificationSent": true,
  "endDate": "2025-12-16T02:22:10.731Z",
  "goal": "text",
  "participants": [
    "text"
  ]
}

200

successful operation

text

Gets the event given by eventId

get

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Responses

200

successful operation

application/json

400

Invalid event id

application/json

get

/dr/dr-events/{eventId}

HTTPcURLJavaScriptPython

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-12-16T02:22:10.731Z",
  "dueDate": "2025-12-16T02:22:10.731Z",
  "endDate": "2025-12-16T02:22:10.731Z",
  "description": "text",
  "location": {
    "project": "text",
    "site": "text",
    "system": "text",
    "node": "text",
    "device": "text"
  },
  "notes": [
    {
      "noteDate": "2025-12-16T02:22:10.731Z",
      "note": "text"
    }
  ]
}

Modifies a demand response event given by eventId

put

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Body

application/json

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

/dr/dr-events/{eventId}

HTTPcURLJavaScriptPython

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-12-16T02:22:10.731Z",
  "notificationDate": "2025-12-16T02:22:10.731Z",
  "notificationSent": true,
  "endDate": "2025-12-16T02:22:10.731Z",
  "goal": "text",
  "participants": [
    "text"
  ]
}

200

successful operation

text

Deletes the event given by eventId

delete

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Responses

200

successful operation

No content

400

Invalid event id

application/json

delete

/dr/dr-events/{eventId}

HTTPcURLJavaScriptPython

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

No content