Systems

Create a new system

post

Create a new system with the specified ID

Authorizations

Path parameters

projectIdstringRequired

The project ID

siteIdstringRequired

The site ID

systemIdstringRequired

The system ID

Body

Refer to the /schemas/system endpoint for the full JSON Schema definition

codestringRequiredPattern: ^[A-Z0-9]*$

statusstring · enumRequiredDefault: New SystemPossible values:

namestringRequired

startDatestring · dateRequired

typestring · enumRequiredPossible values:

meterNumberstringOptional

contractedDemandnumberOptional

verifiedbooleanOptionalDefault: false

Responses

post

HTTPcURLJavaScriptPython

POST //projects/{projectId}/sites/{siteId}/systems/{systemId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "code": "text",
  "status": "New System",
  "name": "text",
  "startDate": "2025-04-30",
  "type": "generation",
  "meterNumber": "text",
  "contractedDemand": 1,
  "verified": true
}

{
  "site": {
    "code": "text",
    "status": "New System",
    "name": "text",
    "startDate": "2025-04-30",
    "type": "generation",
    "meterNumber": "text",
    "contractedDemand": 1,
    "verified": true
  }
}

Update an existing system

put

Update an existing system

Authorizations

Path parameters

projectIdstringRequired

The project ID

siteIdstringRequired

The site ID

systemIdstringRequired

The system ID

Body

Refer to the /schemas/system endpoint for the full JSON Schema definition

codestringRequiredPattern: ^[A-Z0-9]*$

statusstring · enumRequiredDefault: New SystemPossible values:

namestringRequired

startDatestring · dateRequired

typestring · enumRequiredPossible values:

meterNumberstringOptional

contractedDemandnumberOptional

verifiedbooleanOptionalDefault: false

Responses

put

HTTPcURLJavaScriptPython

PUT //projects/{projectId}/sites/{siteId}/systems/{systemId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "code": "text",
  "status": "New System",
  "name": "text",
  "startDate": "2025-04-30",
  "type": "generation",
  "meterNumber": "text",
  "contractedDemand": 1,
  "verified": true
}

{
  "system": {
    "code": "text",
    "status": "New System",
    "name": "text",
    "startDate": "2025-04-30",
    "type": "generation",
    "meterNumber": "text",
    "contractedDemand": 1,
    "verified": true
  }
}

Deletes an existing system

delete

Deletes an existing system

Authorizations

Path parameters

projectIdstringRequired

The project ID

siteIdstringRequired

The site ID

systemIdstringRequired

The system ID

Responses

Responseobject

delete

HTTPcURLJavaScriptPython

DELETE //projects/{projectId}/sites/{siteId}/systems/{systemId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

{}