Sites

PreviousRecords NextRecords

Create a new site

Create a new site with the specified ID

post

/projects/{projectId}/sites/{siteId}

Authorizations

Path parameters

projectIdstringrequired

The project ID

siteIdstringrequired

The site ID

Body

one of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.ecosuite.io//projects/{projectId}/sites/{siteId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"code":"text","name":"text","address":"text","town":"text","state":"text","lat":1,"long":1,"emissionsApproximationMethod":"static","links":[{"name":"text","url":"https://example.com"}],"contacts":[{"name":"text","type":"text"}]}'

200

400

{
  "site": {
    "code": "text",
    "name": "text",
    "productionStartDate": "2025-02-24",
    "generationStartDate": "2025-02-24",
    "consumptionStartDate": "2025-02-24",
    "storageStartDate": "2025-02-24",
    "address": "text",
    "town": "text",
    "state": "text",
    "lat": 1,
    "long": 1,
    "serviceId": "text",
    "parcelID": "text",
    "parcelAcreage": "text",
    "zoningDistrict": "text",
    "ownerOfRecord": "text",
    "locationId": 1,
    "plantId": "text",
    "utility": "text",
    "timezone": "text",
    "expectedDailyData": 1,
    "accessNotes": "text",
    "emissionsApproximationMethod": "static",
    "links": [
      {
        "name": "text",
        "url": "https://example.com"
      }
    ],
    "contacts": [
      {
        "name": "text",
        "type": "text"
      }
    ]
  }
}

successful operation

Update an existing site

put

/projects/{projectId}/sites/{siteId}

Authorizations

Path parameters

projectIdstringrequired

The project ID

siteIdstringrequired

The site ID

Body

one of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.ecosuite.io//projects/{projectId}/sites/{siteId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"code":"text","name":"text","address":"text","town":"text","state":"text","lat":1,"long":1,"emissionsApproximationMethod":"static","links":[{"name":"text","url":"https://example.com"}],"contacts":[{"name":"text","type":"text"}]}'

200

400

{
  "site": {
    "code": "text",
    "name": "text",
    "productionStartDate": "2025-02-24",
    "generationStartDate": "2025-02-24",
    "consumptionStartDate": "2025-02-24",
    "storageStartDate": "2025-02-24",
    "address": "text",
    "town": "text",
    "state": "text",
    "lat": 1,
    "long": 1,
    "serviceId": "text",
    "parcelID": "text",
    "parcelAcreage": "text",
    "zoningDistrict": "text",
    "ownerOfRecord": "text",
    "locationId": 1,
    "plantId": "text",
    "utility": "text",
    "timezone": "text",
    "expectedDailyData": 1,
    "accessNotes": "text",
    "emissionsApproximationMethod": "static",
    "links": [
      {
        "name": "text",
        "url": "https://example.com"
      }
    ],
    "contacts": [
      {
        "name": "text",
        "type": "text"
      }
    ]
  }
}

successful operation

Deletes an existing site

delete

/projects/{projectId}/sites/{siteId}

Authorizations

Path parameters

projectIdstringrequired

The project ID

siteIdstringrequired

The site ID

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

{}

successful operation