Get the operators and the tree of the home sites with its subgsites and operators.
x-ms-visibility: "important"
Send a request to get all the operators and operators' home sites with its subsites related to the customer. For each operator, its authorised sites with chargers, drivers and other operators are also included if not explicitly excluded
Query Parameters
If set to true, the response will exclude hierarchy information.
- 200
- 400
- 401
Return the JSON representation of the operators with all their sites and drivers and operators in the same home site
Schema
- Array [
- Array [
- Array [
- Array [
- Array [
- ]
- Array [
- Array [
- Array [
- ]
- Array [
- ]
- ]
- ]
- Array [
- Array [
- ]
- Array [
- ]
- ]
- Array [
- ]
- ]
- Array [
- Array [
- ]
- Array [
- ]
- ]
- ]
- ]
- ]
- Array [
- Array [
- Array [
- Array [
- ]
- Array [
- Array [
- Array [
- ]
- Array [
- ]
- ]
- ]
- Array [
- Array [
- ]
- Array [
- ]
- ]
- Array [
- ]
- ]
- Array [
- Array [
- ]
- Array [
- ]
- ]
- ]
- ]
operatorGroups object[]
operators object[]
groups object[]
users object[]
tags object[]
Invoicable is meaningful only if you have taken in use the invoicing service, default value is false
chargerGroups object[]
chargers object[]
locationInfo object
chargerConfigurations object[] nullable
sockets object[] nullable
Syntax according to eMI3 standard, for example: FRA23E45B*78C
if false, EVSE UID = chargerId; if true, EVSE UID = chargerId + socketId
customProperties object nullable
Possible values: [0
, 1
, 2
, 3
, 4
]
Default value: 0
chargers object[]
locationInfo object
chargerConfigurations object[] nullable
sockets object[] nullable
Syntax according to eMI3 standard, for example: FRA23E45B*78C
if false, EVSE UID = chargerId; if true, EVSE UID = chargerId + socketId
customProperties object nullable
integratedExternalIds object[]
Possible values: [0
, 1
]
Default value: 0
chargers object[]
locationInfo object
chargerConfigurations object[] nullable
sockets object[] nullable
Syntax according to eMI3 standard, for example: FRA23E45B*78C
if false, EVSE UID = chargerId; if true, EVSE UID = chargerId + socketId
customProperties object nullable
Possible values: [0
, 1
, 2
, 3
, 4
]
Default value: 0
Possible values: [0
, 1
, 2
, 3
, 4
]
Default value: 0
spareOperators object[]
groups object[]
users object[]
tags object[]
Invoicable is meaningful only if you have taken in use the invoicing service, default value is false
chargerGroups object[]
chargers object[]
locationInfo object
chargerConfigurations object[] nullable
sockets object[] nullable
Syntax according to eMI3 standard, for example: FRA23E45B*78C
if false, EVSE UID = chargerId; if true, EVSE UID = chargerId + socketId
customProperties object nullable
Possible values: [0
, 1
, 2
, 3
, 4
]
Default value: 0
chargers object[]
locationInfo object
chargerConfigurations object[] nullable
sockets object[] nullable
Syntax according to eMI3 standard, for example: FRA23E45B*78C
if false, EVSE UID = chargerId; if true, EVSE UID = chargerId + socketId
customProperties object nullable
integratedExternalIds object[]
Possible values: [0
, 1
]
Default value: 0
chargers object[]
locationInfo object
chargerConfigurations object[] nullable
sockets object[] nullable
Syntax according to eMI3 standard, for example: FRA23E45B*78C
if false, EVSE UID = chargerId; if true, EVSE UID = chargerId + socketId
customProperties object nullable
Possible values: [0
, 1
, 2
, 3
, 4
]
Default value: 0
{
"operatorGroups": [
{
"isSpare": true,
"subgroups": [
null
],
"operators": [
{
"id": 0,
"name": "string",
"operatorId": "string",
"emailAddress": "string",
"homeGroupId": 0,
"homeGroupName": "string",
"isAdminOperator": true,
"groups": [
{
"subgroups": [
null
],
"operators": [
null
],
"users": [
{
"id": 0,
"name": "string",
"homeGroupId": 0,
"homeGroupName": "string",
"externalId": "string",
"tags": [
{
"id": 0,
"idTag": "string",
"expiringDate": "2024-10-10T06:49:37.360Z",
"startDate": "2024-10-10T06:49:37.360Z",
"lastUpdated": "2024-10-10T06:49:37.360Z",
"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.360Z",
"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.360Z",
"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.360Z",
"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.361Z",
"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.361Z"
}
]
}
],
"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.361Z",
"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.361Z",
"chargingStationEvseId": 0
}
],
"evseId": "string",
"splitEvseBySocket": true,
"capabilities": [
"string"
],
"physicalReference": "string",
"integrationRelays": [
"string"
],
"iccid": "string",
"imsi": "string",
"meterSerialNumber": "string",
"meterType": "string",
"customProperties": {}
}
],
"id": 0,
"groupName": "string",
"groupType": 0,
"externalId": "string"
}
]
}
],
"id": 0,
"groupName": "string",
"groupType": 0,
"externalId": "string"
}
],
"spareOperators": [
{
"id": 0,
"name": "string",
"operatorId": "string",
"emailAddress": "string",
"homeGroupId": 0,
"homeGroupName": "string",
"isAdminOperator": true,
"groups": [
{
"subgroups": [
null
],
"operators": [
null
],
"users": [
{
"id": 0,
"name": "string",
"homeGroupId": 0,
"homeGroupName": "string",
"externalId": "string",
"tags": [
{
"id": 0,
"idTag": "string",
"expiringDate": "2024-10-10T06:49:37.362Z",
"startDate": "2024-10-10T06:49:37.362Z",
"lastUpdated": "2024-10-10T06:49:37.362Z",
"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.362Z",
"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.362Z",
"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.362Z",
"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.362Z",
"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.362Z"
}
]
}
],
"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.362Z",
"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.363Z",
"chargingStationEvseId": 0
}
],
"evseId": "string",
"splitEvseBySocket": true,
"capabilities": [
"string"
],
"physicalReference": "string",
"integrationRelays": [
"string"
],
"iccid": "string",
"imsi": "string",
"meterSerialNumber": "string",
"meterType": "string",
"customProperties": {}
}
],
"id": 0,
"groupName": "string",
"groupType": 0,
"externalId": "string"
}
]
}
]
}
{"operatorGroups":[{"isSpare":false,"id":2,"name":"OperatorSite1","subgroups":"here list of subsites","operators":"here list of operators"},{"isSpare":false,"id":3,"name":"OperatorSite3","subgroups":"here list of subsites","operators":"here list of operators"},{"isSpare":true,"id":1,"name":"SpareGroup","subgroups":"empty list","operators":"here list of operators without home site"}],"spareOperator":[{"id":1,"name":"OperatorTest1","emailAddress":"operatortest1@company.com","homeGroupId":0,"homeGroupName":"","groups":"here list of sites with chargers, drivers and operators"},{"id":3,"name":"OperatorTest3","emailAddress":"operatortest3@company.com","homeGroupId":0,"homeGroupName":"","groups":"here list of sites with chargers, drivers and operators"}]}
Errors in the route parameters
Customer not found or not authorised