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. Users

Notifications

PreviousMfaNextResend

Deletes a new user notification

delete

Deletes a new user notification

Authorizations
Path parameters
userIdstringRequired

The ID of the user

notificationIdstringRequired

The ID of the notification

Responses
200
successful operation
application/json
Responseobject
400
Invalid status value
application/json
delete
DELETE //users/{userId}/notifications/{notificationId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

{}
  • GETList the notifications for a user
  • POSTCreates a new user notification
  • PUTUpdates a new user notification
  • DELETEDeletes a new user notification

List the notifications for a user

get

Get the users MFA status

Authorizations
Path parameters
userIdstringRequired

The ID of the user

Responses
200
successful operation
application/json
400
Invalid status value
application/json
get
GET //users/{userId}/notifications HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "notifications": [
    {}
  ]
}

Creates a new user notification

post

Creates a new user notification

Authorizations
Path parameters
userIdstringRequired

The ID of the user

Body
objectOptional

Refer to the /schemas/notification endpoint for the JSON Schema definition

Responses
200
successful operation
application/json
400
Invalid status value
application/json
post
POST //users/{userId}/notifications HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "notification": {}
}

Updates a new user notification

put

Updates a new user notification

Authorizations
Path parameters
userIdstringRequired

The ID of the user

notificationIdstringRequired

The ID of the notification

Body
objectOptional

Refer to the /schemas/notification endpoint for the JSON Schema definition

Responses
200
successful operation
application/json
400
Invalid status value
application/json
put
PUT //users/{userId}/notifications/{notificationId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "notification": {}
}