Skip to main content
API

Get a single site with its subsites and chargers​

x-ms-visibility: "important"

Send a request to get a single site by its external id. Its subsites and chargers are included.

Path Parameters
    externalId string required

    This is id from an external system for the site

Query Parameters
    excludeSubgroups string

    If false, all the subsites are included in the reply. If true, no subsite data is added. Default if omitted: false

Responses

Returns the JSON representation of the site with all its subsites and chargers

Schema
    streetAddress string
    postalNumber string
    city string
    area string
    country string
    latitude double nullable
    longitude double nullable
    onlineSocket int32
    offlineSocket int32
    errorSocket int32
    subgroups undefined[]
    chargers object[]
  • Array [
    • dlmGroupId int64 nullable
    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
    dlmGroupId int64 nullable
    publicName string
    timezone string
    publish boolean nullable
    parkingType int32 nullable

    Possible values: [0, 1, 2, 3, 4, 5, 6, 7]

    Default value: 0

    parentId int64 nullable
    tariffReferences object[]
  • Array [
    • tariffId string
    usageType int32

    Possible values: [0, 1]

    Default value: 0

  • ]
    • id int64
    groupName string
    groupType int32 nullable

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

    Default value: 0

    externalId string
Loading...