Systems

PreviousRecords NextRecords

Create a new system

Create a new system with the specified ID

post

/projects/{projectId}/sites/{siteId}/systems/{systemId}

Authorizations

Path parameters

projectIdstringrequired

The project ID

siteIdstringrequired

The site ID

systemIdstringrequired

The system ID

Body

one of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.ecosuite.io//projects/{projectId}/sites/{siteId}/systems/{systemId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"code":"text","name":"text","startDate":"2025-02-24","verified":false,"status":"New System","type":"generation"}'

200

400

{
  "site": {
    "code": "text",
    "name": "text",
    "startDate": "2025-02-24",
    "meterNumber": "text",
    "contractedDemand": 1,
    "verified": false,
    "status": "New System",
    "type": "generation"
  }
}

successful operation

Update an existing system

put

/projects/{projectId}/sites/{siteId}/systems/{systemId}

Authorizations

Path parameters

projectIdstringrequired

The project ID

siteIdstringrequired

The site ID

systemIdstringrequired

The system ID

Body

one of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.ecosuite.io//projects/{projectId}/sites/{siteId}/systems/{systemId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"code":"text","name":"text","startDate":"2025-02-24","verified":false,"status":"New System","type":"generation"}'

200

400

{
  "system": {
    "code": "text",
    "name": "text",
    "startDate": "2025-02-24",
    "meterNumber": "text",
    "contractedDemand": 1,
    "verified": false,
    "status": "New System",
    "type": "generation"
  }
}

successful operation

Deletes an existing system

delete

/projects/{projectId}/sites/{siteId}/systems/{systemId}

Authorizations

Path parameters

projectIdstringrequired

The project ID

siteIdstringrequired

The site ID

systemIdstringrequired

The system ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.ecosuite.io//projects/{projectId}/sites/{siteId}/systems/{systemId}' \
  --header 'Authorization: YOUR_API_KEY'

200

400

{}

successful operation