API Documentation
  • API Documentation
  • Ecosuite Project Data API
    • Authentication
    • OpenAPI reference
      • Events
        • Resolve
      • Feedback
      • Profile
      • Portfolios
      • Projects
        • Contacts
        • Pro forma
          • Versions
        • I2x
        • Records
        • Sites
          • Records
          • Systems
            • Records
        • Record documents
      • Record documents
      • Records
        • Record documents
      • Service requests
        • Generate
        • Resolve
      • Tariff
      • User groups
      • Users
        • Alerts
        • Groups
          • Reset
        • Mfa
        • Notifications
        • Resend
      • User types
      • Audit
        • Assets
        • Projects
        • Users
      • Coda
        • Milestones
        • Import
      • Connectivity
        • Data
        • Devices
      • Dashboard
        • Status
      • Energy
        • Datums
          • Most recent
          • Projects
          • Consumption
            • Cost
              • Projects
            • Predicted
              • Projects
            • Projects
          • Cumulative
            • Projects
          • Generation
            • Expected
            • Predicted
              • Projects
          • Nodes
            • Projects
        • Export
        • Instantaneous
        • Readings
        • Status
      • Finance
        • Cashflow totals
        • Report
        • Transactions
        • Sources uses
          • Sources uses
        • Export
          • Report
        • Projects
          • Billing
          • CashFlowTimeSeriesArrears
          • Categories
          • Irr categories
          • Report
          • Settings
          • Sources uses
          • Import
          • Cash flows
            • Payment logs
          • Pro forma
            • Irr
        • Record
          • Payments
        • Softledger
          • Locations
      • Media
        • Files
        • Tags
          • Storage
            • Code
            • Labels
          • Default
        • Storage
          • File
          • Code
      • Public
        • Projects
        • Energy
          • Datums
            • Projects
          • Readings
            • Projects
      • Schemas
        • Rfi
        • RfiReply
        • Dr event
        • Dr notification
        • Event
        • Participant
        • Finance
        • Notification
        • Portfolio
        • Pro forma
        • Profile
        • Project
        • Record
        • Service request
        • Site
        • System
        • User
        • User type
        • User groups
        • New tariff
        • Tariff
      • Rfi
        • Thread
          • Code
          • Resolve
          • Version
          • Replies
        • Reply
          • Version
      • Search
        • Refinements
      • Solarnetwork
        • Devices
        • Instruction
        • Nodes
        • Ssh
        • Credentials
          • Solarflux
          • Solarnode
          • Ssh
        • Metadata
          • Projects
        • Settings
          • Node ids
        • Solarnode
          • Login url
      • Tools
        • Address business details
      • Dr
        • Participants
        • Dr events
        • Dr notifications
      • Report
        • Operating
          • Project
      • Weather
        • Datums
          • Projects
        • Daylight
          • Projects
            • Sites
        • Projects
          • Sites
    • OpenAPI Specification
  • Ecosuite Time Series Data API
Powered by GitBook
On this page
  1. Ecosuite Project Data API
  2. OpenAPI reference
  3. Dr

Dr events

PreviousParticipantsNextDr notifications

Gets the event given by eventId

get
Authorizations
Responses
200
successful operation
application/json
400
Invalid event id
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-06-16T11:40:49.674Z",
  "dueDate": "2025-06-16T11:40:49.674Z",
  "endDate": "2025-06-16T11:40:49.674Z",
  "description": "text",
  "location": {
    "project": "text",
    "site": "text",
    "system": "text",
    "node": "text",
    "device": "text"
  },
  "notes": [
    {
      "noteDate": "2025-06-16T11:40:49.674Z",
      "note": "text"
    }
  ]
}

Deletes the event given by eventId

delete
Authorizations
Responses
200
successful operation
400
Invalid event id
application/json
delete
DELETE //dr/dr-events/{eventId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

No content
  • GETList the demand response events
  • POSTCreates a new demand response event
  • GETGets the event given by eventId
  • PUTModifies a demand response event given by eventId
  • DELETEDeletes the event given by eventId

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-06-16T11:40:49.674Z",
      "notificationDate": "2025-06-16T11:40:49.674Z",
      "notificationSent": true,
      "endDate": "2025-06-16T11:40:49.674Z",
      "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-06-16T11:40:49.674Z",
  "notificationDate": "2025-06-16T11:40:49.674Z",
  "notificationSent": true,
  "endDate": "2025-06-16T11:40:49.674Z",
  "goal": "text",
  "participants": [
    "text"
  ]
}
200

successful operation

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-06-16T11:40:49.674Z",
  "notificationDate": "2025-06-16T11:40:49.674Z",
  "notificationSent": true,
  "endDate": "2025-06-16T11:40:49.674Z",
  "goal": "text",
  "participants": [
    "text"
  ]
}
200

successful operation

text