Get the drivers and the tree of the home sites with its subsites and drivers

x-ms-visibility: "important"

Send a request to get all drivers and driver home sites with their subsites and drivers for the customer

Responses

• 200
• 400
• 401

---

Return the JSON representation of all the drivers of the customer with its sites, chargers and tags

application/json

Schema

Example (from schema)

response

---

Schema

userGroups object[]
Array [
isSpare boolean
subgroups undefined[]
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
]
]
id int64
groupName string
groupType int32 nullable
Possible values: [0, 1, 2, 3, 4]
Default value: 0
externalId string
]
spareUsers 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
]
]

{
  "userGroups": [
    {
      "isSpare": true,
      "subgroups": [
        null
      ],
      "users": [
        {
          "id": 0,
          "name": "string",
          "homeGroupId": 0,
          "homeGroupName": "string",
          "externalId": "string",
          "tags": [
            {
              "id": 0,
              "idTag": "string",
              "expiringDate": "2024-10-10T06:49:37.450Z",
              "startDate": "2024-10-10T06:49:37.450Z",
              "lastUpdated": "2024-10-10T06:49:37.450Z",
              "tokenName": "string",
              "invoicable": true
            }
          ],
          "chargerGroups": [
            {
              "onlineSocket": 0,
              "offlineSocket": 0,
              "errorSocket": 0,
              "subgroups": [
                null
              ],
              "chargers": [
                {
                  "id": 0,
                  "chargerId": "string",
                  "chargerName": "string",
                  "groupId": 0,
                  "groupName": "string",
                  "firmwareVersion": "string",
                  "publicGroupName": "string",
                  "manufacturer": "string",
                  "serialNumber": "string",
                  "chargerModel": "string",
                  "lastSeen": "2024-10-10T06:49:37.451Z",
                  "lastMessage": "string",
                  "activeConnection": true,
                  "chargerStatus": "string",
                  "locationInfo": {
                    "latitude": 0,
                    "longitude": 0,
                    "streetAddress": "string",
                    "streetNumber": "string",
                    "houseLetter": "string",
                    "postalNumber": "string",
                    "city": "string",
                    "area": "string",
                    "country": "string"
                  },
                  "pushIntegrationEnabled": true,
                  "chargerSpecificMessageStructure": true,
                  "chargerConfigurations": [
                    {
                      "configName": "string",
                      "configValue": "string",
                      "canBeChanged": true
                    }
                  ],
                  "sockets": [
                    {
                      "type": "string",
                      "maxPower": "string",
                      "status": "string",
                      "id": 0,
                      "name": "string",
                      "deviceEvseId": 0,
                      "deviceConnectorId": 0,
                      "format": "string",
                      "socketPowerType": "string",
                      "maxWatts": 0,
                      "maxVoltage": 0,
                      "maxAmperage": 0,
                      "phaseRotation": "string",
                      "termsAndConditions": "string",
                      "lastUpdated": "2024-10-10T06:49:37.451Z",
                      "chargingStationEvseId": 0
                    }
                  ],
                  "evseId": "string",
                  "splitEvseBySocket": true,
                  "capabilities": [
                    "string"
                  ],
                  "physicalReference": "string",
                  "integrationRelays": [
                    "string"
                  ],
                  "iccid": "string",
                  "imsi": "string",
                  "meterSerialNumber": "string",
                  "meterType": "string",
                  "customProperties": {}
                }
              ],
              "payerId": 0,
              "costId": "string",
              "costName": "string",
              "paymentRecipientId": 0,
              "id": 0,
              "groupName": "string",
              "groupType": 0,
              "externalId": "string"
            }
          ],
          "chargers": [
            {
              "id": 0,
              "chargerId": "string",
              "chargerName": "string",
              "groupId": 0,
              "groupName": "string",
              "firmwareVersion": "string",
              "publicGroupName": "string",
              "manufacturer": "string",
              "serialNumber": "string",
              "chargerModel": "string",
              "lastSeen": "2024-10-10T06:49:37.451Z",
              "lastMessage": "string",
              "activeConnection": true,
              "chargerStatus": "string",
              "locationInfo": {
                "latitude": 0,
                "longitude": 0,
                "streetAddress": "string",
                "streetNumber": "string",
                "houseLetter": "string",
                "postalNumber": "string",
                "city": "string",
                "area": "string",
                "country": "string"
              },
              "pushIntegrationEnabled": true,
              "chargerSpecificMessageStructure": true,
              "chargerConfigurations": [
                {
                  "configName": "string",
                  "configValue": "string",
                  "canBeChanged": true
                }
              ],
              "sockets": [
                {
                  "type": "string",
                  "maxPower": "string",
                  "status": "string",
                  "id": 0,
                  "name": "string",
                  "deviceEvseId": 0,
                  "deviceConnectorId": 0,
                  "format": "string",
                  "socketPowerType": "string",
                  "maxWatts": 0,
                  "maxVoltage": 0,
                  "maxAmperage": 0,
                  "phaseRotation": "string",
                  "termsAndConditions": "string",
                  "lastUpdated": "2024-10-10T06:49:37.451Z",
                  "chargingStationEvseId": 0
                }
              ],
              "evseId": "string",
              "splitEvseBySocket": true,
              "capabilities": [
                "string"
              ],
              "physicalReference": "string",
              "integrationRelays": [
                "string"
              ],
              "iccid": "string",
              "imsi": "string",
              "meterSerialNumber": "string",
              "meterType": "string",
              "customProperties": {}
            }
          ],
          "payerId": 0,
          "integratedExternalIds": [
            {
              "referenceType": 0,
              "referenceId": "string",
              "externalId": "string",
              "effectiveFrom": "2024-10-10T06:49:37.451Z"
            }
          ]
        }
      ],
      "id": 0,
      "groupName": "string",
      "groupType": 0,
      "externalId": "string"
    }
  ],
  "spareUsers": [
    {
      "id": 0,
      "name": "string",
      "homeGroupId": 0,
      "homeGroupName": "string",
      "externalId": "string",
      "tags": [
        {
          "id": 0,
          "idTag": "string",
          "expiringDate": "2024-10-10T06:49:37.451Z",
          "startDate": "2024-10-10T06:49:37.451Z",
          "lastUpdated": "2024-10-10T06:49:37.451Z",
          "tokenName": "string",
          "invoicable": true
        }
      ],
      "chargerGroups": [
        {
          "onlineSocket": 0,
          "offlineSocket": 0,
          "errorSocket": 0,
          "subgroups": [
            null
          ],
          "chargers": [
            {
              "id": 0,
              "chargerId": "string",
              "chargerName": "string",
              "groupId": 0,
              "groupName": "string",
              "firmwareVersion": "string",
              "publicGroupName": "string",
              "manufacturer": "string",
              "serialNumber": "string",
              "chargerModel": "string",
              "lastSeen": "2024-10-10T06:49:37.452Z",
              "lastMessage": "string",
              "activeConnection": true,
              "chargerStatus": "string",
              "locationInfo": {
                "latitude": 0,
                "longitude": 0,
                "streetAddress": "string",
                "streetNumber": "string",
                "houseLetter": "string",
                "postalNumber": "string",
                "city": "string",
                "area": "string",
                "country": "string"
              },
              "pushIntegrationEnabled": true,
              "chargerSpecificMessageStructure": true,
              "chargerConfigurations": [
                {
                  "configName": "string",
                  "configValue": "string",
                  "canBeChanged": true
                }
              ],
              "sockets": [
                {
                  "type": "string",
                  "maxPower": "string",
                  "status": "string",
                  "id": 0,
                  "name": "string",
                  "deviceEvseId": 0,
                  "deviceConnectorId": 0,
                  "format": "string",
                  "socketPowerType": "string",
                  "maxWatts": 0,
                  "maxVoltage": 0,
                  "maxAmperage": 0,
                  "phaseRotation": "string",
                  "termsAndConditions": "string",
                  "lastUpdated": "2024-10-10T06:49:37.452Z",
                  "chargingStationEvseId": 0
                }
              ],
              "evseId": "string",
              "splitEvseBySocket": true,
              "capabilities": [
                "string"
              ],
              "physicalReference": "string",
              "integrationRelays": [
                "string"
              ],
              "iccid": "string",
              "imsi": "string",
              "meterSerialNumber": "string",
              "meterType": "string",
              "customProperties": {}
            }
          ],
          "payerId": 0,
          "costId": "string",
          "costName": "string",
          "paymentRecipientId": 0,
          "id": 0,
          "groupName": "string",
          "groupType": 0,
          "externalId": "string"
        }
      ],
      "chargers": [
        {
          "id": 0,
          "chargerId": "string",
          "chargerName": "string",
          "groupId": 0,
          "groupName": "string",
          "firmwareVersion": "string",
          "publicGroupName": "string",
          "manufacturer": "string",
          "serialNumber": "string",
          "chargerModel": "string",
          "lastSeen": "2024-10-10T06:49:37.452Z",
          "lastMessage": "string",
          "activeConnection": true,
          "chargerStatus": "string",
          "locationInfo": {
            "latitude": 0,
            "longitude": 0,
            "streetAddress": "string",
            "streetNumber": "string",
            "houseLetter": "string",
            "postalNumber": "string",
            "city": "string",
            "area": "string",
            "country": "string"
          },
          "pushIntegrationEnabled": true,
          "chargerSpecificMessageStructure": true,
          "chargerConfigurations": [
            {
              "configName": "string",
              "configValue": "string",
              "canBeChanged": true
            }
          ],
          "sockets": [
            {
              "type": "string",
              "maxPower": "string",
              "status": "string",
              "id": 0,
              "name": "string",
              "deviceEvseId": 0,
              "deviceConnectorId": 0,
              "format": "string",
              "socketPowerType": "string",
              "maxWatts": 0,
              "maxVoltage": 0,
              "maxAmperage": 0,
              "phaseRotation": "string",
              "termsAndConditions": "string",
              "lastUpdated": "2024-10-10T06:49:37.452Z",
              "chargingStationEvseId": 0
            }
          ],
          "evseId": "string",
          "splitEvseBySocket": true,
          "capabilities": [
            "string"
          ],
          "physicalReference": "string",
          "integrationRelays": [
            "string"
          ],
          "iccid": "string",
          "imsi": "string",
          "meterSerialNumber": "string",
          "meterType": "string",
          "customProperties": {}
        }
      ],
      "payerId": 0,
      "integratedExternalIds": [
        {
          "referenceType": 0,
          "referenceId": "string",
          "externalId": "string",
          "effectiveFrom": "2024-10-10T06:49:37.452Z"
        }
      ]
    }
  ]
}

{"userGroups":[{"isSpare":false,"id":2,"name":"DriverSiteTest1","subgroups":"here list of subsites","users":"here list of drivers"},{"isSpare":false,"id":3,"name":"DriverSiteTest3","subgroups":"here list of subsites","users":"here list of drivers"},{"isSpare":true,"id":1,"name":"SpareGroup","subgroups":"empty list","users":"here list of spare drivers"}],"spareUsers":[{"id":1,"name":"DriverWithoutSite","homeGroupId":0,"homeGroupName":"","externalId":"extDriverTestId","tags":"here the list of tags","groups":"here list of sites","chargers":"here list of chargers"}]}

Errors in the route parameters

Customer not found or not authorised

Loading...