Energy Management API

Panels

Download Spec

get/energy-management/v1/panels

Get a list of panels

limitstring

Pattern: ^[0-9][0-9]?$|^100$
Default: "20"

startingAfterstring

Max Length: 50

locationIdstring

Max Length: 50

Responses

Response examples

List of panels

{
  "hasMore": true,
  "items": [
    {
      "id": "string",
      "name": "string",
      "networkId": "string",
      "locationId": "string",
      "voltageRating": "208/240",
      "amperageRating": 123.0,
      "phaseType": "3-phase",
      "breakers": [
        {
          "name": "string",
          "sortOrder": 123.0,
          "phase": "AB",
          "amperageRating": 123.0,
          "station1": {
            "id": "string"
          },
          "station2": {
            "id": "string"
          }
        }
      ],
      "isArchived": true,
      "createdAt": "2023-06-07T17:32:28Z",
      "updatedAt": "2023-06-07T17:32:28Z"
    }
  ]
}

post/energy-management/v1/panels

Create a panel

namestring

required

Min Length: 1
Max Length: 50

networkIdstring

required

Min Length: 1
Max Length: 50

locationIdstring

required

Min Length: 1
Max Length: 50

voltageRatingstring

required

Enum: 208/240
480

amperageRatingnumber

required

phaseTypestring

required

Enum: 3-phase
1-phase

breakersarray

required

namestring

required

Min Length: 1
Max Length: 50

sortOrdernumber

required

phasestring

required

Enum: AB
BC
CA
ABC
NONE

amperageRatingnumber

required

station1object

required

station2object

Responses

Request examples

{
  "name": "string",
  "networkId": "string",
  "locationId": "string",
  "voltageRating": "208/240",
  "amperageRating": 123.0,
  "phaseType": "3-phase",
  "breakers": [
    {
      "name": "string",
      "sortOrder": 123.0,
      "phase": "AB",
      "amperageRating": 123.0,
      "station1": {
        "id": "string"
      },
      "station2": {
        "id": "string"
      }
    }
  ]
}

Response examples

Panel was created successfully.

{
  "data": {
    "id": "string",
    "name": "string",
    "networkId": "string",
    "locationId": "string",
    "voltageRating": "208/240",
    "amperageRating": 123.0,
    "phaseType": "3-phase",
    "breakers": [
      {
        "name": "string",
        "sortOrder": 123.0,
        "phase": "AB",
        "amperageRating": 123.0,
        "station1": {
          "id": "string"
        },
        "station2": {
          "id": "string"
        }
      }
    ],
    "isArchived": true,
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  }
}

get/energy-management/v1/panels/{id}

Get a single panel

idstring

required

Min Length: 1
Max Length: 50

Responses

Response examples

A single panel.

{
  "data": {
    "id": "string",
    "name": "string",
    "networkId": "string",
    "locationId": "string",
    "voltageRating": "208/240",
    "amperageRating": 123.0,
    "phaseType": "3-phase",
    "breakers": [
      {
        "name": "string",
        "sortOrder": 123.0,
        "phase": "AB",
        "amperageRating": 123.0,
        "station1": {
          "id": "string"
        },
        "station2": {
          "id": "string"
        }
      }
    ],
    "isArchived": true,
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  }
}

patch/energy-management/v1/panels/{id}

Update a panel

idstring

required

Min Length: 1
Max Length: 50

namestring

required

Min Length: 1
Max Length: 50

networkIdstring

required

Min Length: 1
Max Length: 50

locationIdstring

required

Min Length: 1
Max Length: 50

voltageRatingstring

required

Enum: 208/240
480

amperageRatingnumber

required

phaseTypestring

required

Enum: 3-phase
1-phase

breakersarray

required

namestring

required

Min Length: 1
Max Length: 50

sortOrdernumber

required

phasestring

required

Enum: AB
BC
CA
ABC
NONE

amperageRatingnumber

required

station1object

required

station2object

Responses

Request examples

{
  "id": "string",
  "name": "string",
  "networkId": "string",
  "locationId": "string",
  "voltageRating": "208/240",
  "amperageRating": 123.0,
  "phaseType": "3-phase",
  "breakers": [
    {
      "name": "string",
      "sortOrder": 123.0,
      "phase": "AB",
      "amperageRating": 123.0,
      "station1": {
        "id": "string"
      },
      "station2": {
        "id": "string"
      }
    }
  ]
}

Response examples

Updated panel successfully

{
  "data": {
    "id": "string",
    "name": "string",
    "networkId": "string",
    "locationId": "string",
    "voltageRating": "208/240",
    "amperageRating": 123.0,
    "phaseType": "3-phase",
    "breakers": [
      {
        "name": "string",
        "sortOrder": 123.0,
        "phase": "AB",
        "amperageRating": 123.0,
        "station1": {
          "id": "string"
        },
        "station2": {
          "id": "string"
        }
      }
    ],
    "isArchived": true,
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  }
}

put/energy-management/v1/panels/{id}/archive

Archive a panel

idstring

required

Min Length: 1
Max Length: 50

Responses

Response examples

Panel was archived successfully.

{
  "data": {
    "id": "string",
    "name": "string",
    "networkId": "string",
    "locationId": "string",
    "voltageRating": "208/240",
    "amperageRating": 123.0,
    "phaseType": "3-phase",
    "breakers": [
      {
        "name": "string",
        "sortOrder": 123.0,
        "phase": "AB",
        "amperageRating": 123.0,
        "station1": {
          "id": "string"
        },
        "station2": {
          "id": "string"
        }
      }
    ],
    "isArchived": true,
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  }
}

Was this page helpful?