Get an overview of chargers

x-ms-visibility: "important"

Retrieve the total count of chargers and their socket statuses.

Query Parameters

siteId int64

Filter by site ID. The results will include data from all the subsites as well.

Responses

• 200
• 400
• 401

---

Overview of chargers, including count and socket statuses.

application/json

Schema

Example (from schema)

---

Schema

chargers object
total int32
online int32
offline int32
available int32
preparing int32
charging int32
error int32
sockets object
total int32
online int32
offline int32
available int32
preparing int32
charging int32
error int32

{
  "chargers": {
    "total": 0,
    "online": 0,
    "offline": 0,
    "available": 0,
    "preparing": 0,
    "charging": 0,
    "error": 0
  },
  "sockets": {
    "total": 0,
    "online": 0,
    "offline": 0,
    "available": 0,
    "preparing": 0,
    "charging": 0,
    "error": 0
  }
}

Exception Details

application/json

Schema

Example (from schema)

---

Schema

errorCode string
message string
errorNumber int32
helpLink string

{
  "errorCode": "string",
  "message": "string",
  "errorNumber": 0,
  "helpLink": "string"
}

User not authorized

Loading...