Skip to main content
API

Get the tree of all sites with their subsites and chargers​

x-ms-visibility: "important"

Send a request to get all the sites and subgsites with their chargers that belongs to the customer

Query Parameters
    excludeDetails string

    If false, all the chargers and other details are included in the reply. If true, only id, name and type are included. Default if omitted: false

Responses

Return the JSON representation of all sites with all its subsites and chargers.

Schema
  • Array [
    • onlineSocket int32 nullable
    offlineSocket int32 nullable
    errorSocket int32 nullable
    subgroups undefined[]
    chargers object[]
  • Array [
    • id int64 nullable
    chargerId string
    chargerName string
    groupId int64
    groupName string
    firmwareVersion string nullable
    publicGroupName string nullable
    manufacturer string nullable
    serialNumber string nullable
    chargerModel string nullable
    amountOfSockets int32 deprecated
    lastSeen date-time
    lastMessage string nullable
    activeConnection boolean
    chargerStatus string
    locationInfo object
    latitude double
    longitude double
    streetAddress string nullable
    streetNumber string
    houseLetter string nullable
    postalNumber string
    city string nullable
    area string nullable
    country string nullable
    pushIntegrationEnabled boolean
    chargerSpecificMessageStructure boolean
    chargerConfigurations object[] nullable
  • Array [
    • configName string
    configValue string
    canBeChanged boolean
  • ]
    • sockets object[] nullable
  • Array [
    • type string nullable
    maxPower string nullable
    status string
    id int32
    name string
    deviceEvseId int32 nullable
    deviceConnectorId int32 nullable
    format string nullable
    socketPowerType string nullable
    maxWatts int32 nullable
    maxVoltage int32 nullable
    maxAmperage int32 nullable
    phaseRotation string nullable
    termsAndConditions uri nullable
    lastUpdated date-time
    chargingStationEvseId int32 nullable
  • ]
    • evseId string

    Syntax according to eMI3 standard, for example: FRA23E45B*78C

    splitEvseBySocket boolean

    if false, EVSE UID = chargerId; if true, EVSE UID = chargerId + socketId

    capabilities string[]
    physicalReference string nullable
    integrationRelays string[] nullable
    iccid string nullable
    imsi string nullable
    meterSerialNumber string nullable
    meterType string nullable
    customProperties object nullable
    property name* string
  • ]
    • payerId int64 nullable
    costId string
    costName string
    paymentRecipientId int64 nullable
    id int64
    groupName string
    groupType int32 nullable

    Possible values: [0, 1, 2, 3, 4]

    Default value: 0

    externalId string
  • ]
Loading...