Charging Groups (beta)

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.

GET/1/charging-groups

List Charging Groups

Authorization
User sessionAPI credential
Permissions
charging-groups:read
OAuth
-
Request
Query parameters2
limitinteger
skipinteger
Responses
200OK application/json
dataChargingGroup[]
accountIdstring
createdAtstring <date-time>REQUIRED
descriptionstring
filtersChargingGroupFilter[]REQUIRED
accountIdsChargingGroupFilterAccountIDs
idsstring[]REQUIRED
connectorsChargingGroupFilterConnectors
connectorsChargingGroupFilterConnector[]REQUIRED
locationIdsChargingGroupFilterLocationIDs
idsstring[]REQUIRED
idstringREQUIRED
labelstringREQUIRED
providerIdstringREQUIRED
updatedAtstring <date-time>REQUIRED
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/charging-groups

Create Charging Group

Authorization
User sessionAPI credential
Permissions
charging-groups:write
OAuth
-
Request
Request bodyapplication/json
descriptionstring
filtersobject[]REQUIRED
accountIdsobject
idsstring[]
connectorsobject
connectorsobject[]
chargingStationIdstringREQUIRED
connectorIdintegerREQUIRED
min 1
evseIdintegerREQUIRED
min 1
locationIdsobject
idsstring[]
labelstringREQUIRED
Responses
201Created application/json
dataobject
idstringREQUIRED
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/charging-groups/search

Search Charging Groups

Authorization
User sessionAPI credential
Permissions
charging-groups:read
OAuth
-
Request
Request bodyapplication/json
createdAtobject
$gtestring <date-time>
$ltestring <date-time>
idsstring <uuid>[]
limitinteger
default 50min 1
querystring
skipinteger
default 0min 0
Responses
200OK application/json
dataobject
chargingGroupsChargingGroup[]REQUIRED
accountIdstring
createdAtstring <date-time>REQUIRED
descriptionstring
filtersChargingGroupFilter[]REQUIRED
accountIdsChargingGroupFilterAccountIDs
connectorsChargingGroupFilterConnectors
locationIdsChargingGroupFilterLocationIDs
idstringREQUIRED
labelstringREQUIRED
providerIdstringREQUIRED
updatedAtstring <date-time>REQUIRED
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/charging-groups/{id}

Get Charging Group

Authorization
User sessionAPI credential
Permissions
charging-groups:read
OAuth
-
Request
Path parameters1
idstringREQUIRED
Responses
200OK application/json
dataChargingGroup
accountIdstring
createdAtstring <date-time>REQUIRED
descriptionstring
filtersChargingGroupFilter[]REQUIRED
accountIdsChargingGroupFilterAccountIDs
idsstring[]REQUIRED
connectorsChargingGroupFilterConnectors
connectorsChargingGroupFilterConnector[]REQUIRED
locationIdsChargingGroupFilterLocationIDs
idsstring[]REQUIRED
idstringREQUIRED
labelstringREQUIRED
providerIdstringREQUIRED
updatedAtstring <date-time>REQUIRED
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
PUT/1/charging-groups/{id}

Update Charging Group

Authorization
User sessionAPI credential
Permissions
charging-groups:write
OAuth
-
Request
Path parameters1
idstringREQUIRED
Request bodyapplication/json
descriptionstring
filtersobject[]REQUIRED
accountIdsobject
idsstring[]
connectorsobject
connectorsobject[]
chargingStationIdstringREQUIRED
connectorIdintegerREQUIRED
min 1
evseIdintegerREQUIRED
min 1
locationIdsobject
idsstring[]
labelstringREQUIRED
Responses
204Updated 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
DELETE/1/charging-groups/{id}

Delete Charging Group

Authorization
User sessionAPI credential
Permissions
charging-groups:write
OAuth
-
Request
Path parameters1
idstringREQUIRED
Responses
204Deleted 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
POST/1/charging-groups/{id}/filter-member

Add Filter Member

Authorization
User sessionAPI credential
Permissions
charging-groups:write
OAuth
-
Request
Path parameters1
idstringREQUIRED
Request bodyapplication/json
connectorobject
chargingStationIdstring <uuid>REQUIRED
ocppConnectorIdintegerREQUIRED
min 1
ocppEvseIdintegerREQUIRED
min 1
filterAccountIdstring
filterLocationIdstring
Responses
204Added 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
DELETE/1/charging-groups/{id}/filter-member

Remove Filter Member

Authorization
User sessionAPI credential
Permissions
charging-groups:write
OAuth
-
Request
Path parameters1
idstringREQUIRED
Query parameters5
chargingStationIdstring
ocppEvseIdinteger
ocppConnectorIdinteger
filterLocationIdstring
filterAccountIdstring
Responses
204Removed 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