EVSE Controllers
No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.
No Road deviations in this section. Turn off the deviations filter in the sidebar to see all of its endpoints.
EVSE Controllers Management
POST/1/evse-controllers/mine
Search My EVSE Controllers
Search EVSE controllers for the current user.
Authorization
User sessionAPI credentialPermissions
-
OAuth
-
Request
Request bodyapplication/json
filenamestring
default
evse-controllers.csvformatstring
default
jsonfromstring <date-time>
idstring
idsstring[]
ignoreOtherUserLocationsboolean
includeIntegrationsboolean
limitnumber
default
50localestring
Browser locale, e.g. nl-NL, for a CSV export: sets its decimal sign and delimiter. Without it the CSV keeps its default format.
locationIdsstring[]
monthnumber
searchIdstring
searchPhrasestring
skipnumber
default
0sortobjectdefault {"field":"createdAt","order":"desc"}
sortobject
default
{"field":"createdAt","order":"desc"}fieldstringREQUIRED
orderstringREQUIRED
ascdesctostring <date-time>
yearnumber
Responses
200OK application/json
dataEvseControllerResource[]REQUIRED
dataEvseControllerResource[]REQUIRED
accessGroupIdsstring[]
accessGroupsobject[]
accountobject
accountIdstring
billingPlanobject
billingPlanIdstring
bootInfoobject
chargeCardPairingCompatibilityChargeCardPairingCompatibility
chargeCardPairingCompatibilityChargeCardPairingCompatibility
compatiblebooleanREQUIRED
A charge card can be paired on this charging station.
deviceNamestring
matchedAtstring <date-time>REQUIRED
syncToDevicebooleanREQUIRED
The paired card is also written onto the device. False when not compatible.
configurationEvseControllerConfigurationItem[]
configurationEvseControllerConfigurationItem[]
componentobject
componentobject
instancestring
namestringREQUIRED
connectorIdnumber
evseIdnumber
keystringREQUIRED
readonlybooleanREQUIRED
valueobjectREQUIRED
variableobject
variableobject
instancestring
namestringREQUIRED
configurationFetchedAtstring
connectivityStatestring
connectorStatusobject
connectorsobject[]
coordinatorStatusobject
costSettingsobject[]
createdAtstringREQUIRED
descriptionstring
enablePublicChargingboolean
enablePublicFreeChargingboolean
enableTariffProfileOverrideboolean
evseIdstring
evseIdModestring
evseIdRefobject
evseOperationalStatusobject
evseOperationalStatusIdstring
heartbeatReceivedAtstring
idstringREQUIRED
isDisabledboolean
isPairingChargeCardAllowedboolean
labelsstring[]
locationobject
locationIdstring
maintenanceAccountobject
maintenanceAccountIdstring
namestring
numConnectorsnumber
ocppChargingStationIdstring
ocppIdentitystring
opChargingStationIdstring
optOutOfScanToPayboolean
pairedChargeCardobject
pairedChargeCardIdstring
providerobject
providerIdstringREQUIRED
serialNumberstring
smartChargingobject
tariffProfileobject
tariffProfileIdstring
updatedAtstringREQUIRED
metaobjectREQUIRED
metaobjectREQUIRED
limitnumberREQUIRED
skipnumberREQUIRED
totalnumberREQUIRED
400Invalid Request application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
GET/1/evse-controllers/{evseController}
Get EVSE Controller by ID
Authorization
User sessionAPI credentialPermissions
evse-controllers:readOAuth
-
Request
Path parameters1
evseControllerstringREQUIRED
Responses
200OK application/json
dataEvseControllerResource
dataEvseControllerResource
accessGroupIdsstring[]
accessGroupsobject[]
accountobject
accountIdstring
billingPlanobject
billingPlanIdstring
bootInfoobject
chargeCardPairingCompatibilityChargeCardPairingCompatibility
chargeCardPairingCompatibilityChargeCardPairingCompatibility
compatiblebooleanREQUIRED
A charge card can be paired on this charging station.
deviceNamestring
matchedAtstring <date-time>REQUIRED
syncToDevicebooleanREQUIRED
The paired card is also written onto the device. False when not compatible.
configurationEvseControllerConfigurationItem[]
configurationEvseControllerConfigurationItem[]
componentobject
componentobject
instancestring
namestringREQUIRED
connectorIdnumber
evseIdnumber
keystringREQUIRED
readonlybooleanREQUIRED
valueobjectREQUIRED
variableobject
variableobject
instancestring
namestringREQUIRED
configurationFetchedAtstring
connectivityStatestring
connectorStatusobject
connectorsobject[]
coordinatorStatusobject
costSettingsobject[]
createdAtstringREQUIRED
descriptionstring
enablePublicChargingboolean
enablePublicFreeChargingboolean
enableTariffProfileOverrideboolean
evseIdstring
evseIdModestring
evseIdRefobject
evseOperationalStatusobject
evseOperationalStatusIdstring
heartbeatReceivedAtstring
idstringREQUIRED
isDisabledboolean
isPairingChargeCardAllowedboolean
labelsstring[]
locationobject
locationIdstring
maintenanceAccountobject
maintenanceAccountIdstring
namestring
numConnectorsnumber
ocppChargingStationIdstring
ocppIdentitystring
opChargingStationIdstring
optOutOfScanToPayboolean
pairedChargeCardobject
pairedChargeCardIdstring
providerobject
providerIdstringREQUIRED
serialNumberstring
smartChargingobject
tariffProfileobject
tariffProfileIdstring
updatedAtstringREQUIRED
metaobject
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED