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

User types

PreviousResendNextAudit

Delete the user type

delete

Delete the user type

Authorizations
Path parameters
userTypeIdstringRequired

The ID of the user type

Responses
Responseobject
delete
DELETE //user-types/{userTypeId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

{}
  • GETList the user types
  • POSTCreates a new user type assigning them a server generated ID
  • GETGet the user type
  • PUTUpdate the user type
  • DELETEDelete the user type

List the user types

get

List the user types

Authorizations
Responses
get
GET //user-types HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "userTypes": {
    "id": "text",
    "name": "text",
    "application": "ams"
  }
}

Creates a new user type assigning them a server generated ID

post

Creates a new user type assigning them a server generated ID

Authorizations
Body

Refer to the /schemas/user-type endpoint for the full JSON Schema definition

idstringRead-onlyOptional
namestringRequired
applicationstring · enumRequiredPossible values:
Responses
post
POST //user-types HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "name": "text",
  "application": "ams"
}
{
  "id": "text",
  "name": "text",
  "application": "ams"
}

Get the user type

get

Get the user type

Authorizations
Path parameters
userTypeIdstringRequired

The ID of the user type

Body

Refer to the /schemas/user-type endpoint for the full JSON Schema definition

idstringRead-onlyOptional
namestringRequired
applicationstring · enumRequiredPossible values:
Responses
Responseobject
get
GET //user-types/{userTypeId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "name": "text",
  "application": "ams"
}
{}

Update the user type

put

Update the user type

Authorizations
Path parameters
userTypeIdstringRequired

The ID of the user type

Body

Refer to the /schemas/user-type endpoint for the full JSON Schema definition

idstringRead-onlyOptional
namestringRequired
applicationstring · enumRequiredPossible values:
Responses
Responseobject
put
PUT //user-types/{userTypeId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "name": "text",
  "application": "ams"
}
{}