Documentation

EVSE Issues

No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.

API for management of detected issues with EVSEs

POST/1/evse-issues/search

Search EVSE Issues

List and search EVSE issues with filters.

Authorization
User sessionAPI credential
Permissions
evse-controllers:read
OAuth
-
Request
Request bodyapplication/json
accountIdstring
createdAtobject
$gtenumber | string <date-time>
$ltenumber | string <date-time>
evseControllerEvseOperationalStatusIdsstring[]
evseControllerFirmwareVersionstring
evseControllerIdstring
evseControllerLabelsstring[]
evseControllerMaintenanceAccountIdstring
evseControllerVendorstring
filenamestring
default evseIssues.csv
formatstring
default json
fromstring <date-time>
idstring
idsstring[]
isResolvedboolean
issueTypesstring[]
limitnumber
default 50
locationIdstring
skipnumber
default 0
sortobject
default {"field":"createdAt","order":"desc"}
fieldstringREQUIRED
orderstringREQUIRED
ascdesc
tostring <date-time>
Responses
200OK application/json
dataEvseIssueResource[]
accountobject
accountIdstring
contextobject
createdAtstringREQUIRED
descriptionstringREQUIRED
evseControllerobject
evseControllerIdstring
idstringREQUIRED
isResolvedbooleanREQUIRED
lastDetectedAtstring
locationobject
locationIdstring
maintenanceAccountobject
maintenanceAccountIdstring
providerIdstringREQUIRED
resolvedAtstring
resolvedByCredentialIdstring
resolvedByCredentialNamestring
resolvedByUserobject
resolvedByUserIdstring
resolvedByUserNamestring
severitystringREQUIRED
typestringREQUIRED
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
GET/1/evse-issues/{evseIssue}

Get EVSE Issue

Returns a single EVSE issue.

Authorization
User sessionAPI credential
Permissions
evse-controllers:read
OAuth
-
Request
Path parameters1
evseIssuestringREQUIRED
Responses
200OK application/json
dataEvseIssueResource
accountobject
accountIdstring
contextobject
createdAtstringREQUIRED
descriptionstringREQUIRED
evseControllerobject
evseControllerIdstring
idstringREQUIRED
isResolvedbooleanREQUIRED
lastDetectedAtstring
locationobject
locationIdstring
maintenanceAccountobject
maintenanceAccountIdstring
providerIdstringREQUIRED
resolvedAtstring
resolvedByCredentialIdstring
resolvedByCredentialNamestring
resolvedByUserobject
resolvedByUserIdstring
resolvedByUserNamestring
severitystringREQUIRED
typestringREQUIRED
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
POST/1/evse-issues/{evseIssue}/resolve

Resolve EVSE Issue

Resolve a single EVSE issue.

Authorization
User sessionAPI credential
Permissions
evse-controllers:read
OAuth
-
Request
Path parameters1
evseIssuestringREQUIRED
Responses
204OK text/plain
Returns a file (Text).
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