Documentation

EVSE Controllers

No OAuth-enabled endpoints in this section. Turn off the OAuth 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 credential
Permissions
-
OAuth
-
Request
Request bodyapplication/json
filenamestring
default evse-controllers.csv
formatstring
default json
fromstring <date-time>
idstring
idsstring[]
ignoreOtherUserLocationsboolean
includeIntegrationsboolean
limitnumber
default 50
locationIdsstring[]
monthnumber
searchIdstring
searchPhrasestring
skipnumber
default 0
sortobject
default {"field":"createdAt","order":"desc"}
fieldstringREQUIRED
orderstringREQUIRED
ascdesc
tostring <date-time>
yearnumber
Responses
200OK application/json
dataEvseControllerResource[]REQUIRED
accessGroupIdsstring[]
accessGroupsobject[]
accountobject
accountIdstring
billingPlanobject
billingPlanIdstring
bootInfoobject
configurationEvseControllerConfigurationItem[]
componentobject
instancestring
namestringREQUIRED
connectorIdnumber
evseIdnumber
keystringREQUIRED
readonlybooleanREQUIRED
valueobjectREQUIRED
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
limitnumberREQUIRED
skipnumberREQUIRED
totalnumberREQUIRED
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
GET/1/evse-controllers/{evseController}

Get EVSE Controller by ID

Authorization
User sessionAPI credential
Permissions
evse-controllers:read
OAuth
-
Request
Path parameters1
evseControllerstringREQUIRED
Responses
200OK application/json
dataEvseControllerResource
accessGroupIdsstring[]
accessGroupsobject[]
accountobject
accountIdstring
billingPlanobject
billingPlanIdstring
bootInfoobject
configurationEvseControllerConfigurationItem[]
componentobject
instancestring
namestringREQUIRED
connectorIdnumber
evseIdnumber
keystringREQUIRED
readonlybooleanREQUIRED
valueobjectREQUIRED
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
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED