Skip to main content
API

Get all drivers having access right to given sites​

x-ms-visibility: "important"

Send a request to get all drivers that have charging rights to the sites' chargers

Request Body required

List of site ids to retrieve drivers for. The limit of ids that can be passed to this call is 20

    groupIds int64[]
Responses

Return the JSON representation of all the drivers authorised for the site

Schema
  • Array [
    • groupId int64
    users object[]
  • Array [
    • id int64
    name string
    homeGroupId int64
    homeGroupName string
    externalId string
    tags object[]
  • Array [
    • id int64
    idTag string
    expiringDate date-time
    startDate date-time nullable
    lastUpdated date-time nullable
    tokenName string
    invoicable boolean

    Invoicable is meaningful only if you have taken in use the invoicing service, default value is false

  • ]
    • chargerGroups object[]
  • 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
  • ]
    • 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
    integratedExternalIds object[]
  • Array [
    • referenceType int32

    Possible values: [0, 1]

    Default value: 0

    referenceId string
    externalId string
    effectiveFrom date-time nullable
  • ]
  • ]
  • ]
Loading...