Clear Charging Profile¶
Description.
Clear/remove an existing charging profile by specifying the profile ID OR a charging profile criteria.
The request and response defined on this page are are based on OCPP 2.0.1’s ClearChargingProfile.
- The difference with OCPP are:
data.evse_id is not a number, instead it’s a string like “GB*SEV*E123456789”
all fields use snake_case notation, whereas OCPP uses camelCase
ClearChargingProfileRequest¶
Topic: ocpp/smart_charging. Used by OCPP to request Smart Charging service to remove an existing charging profile. |
||||
type |
object |
|||
properties |
||||
|
type |
string |
||
format |
uuid |
|||
|
const |
clear_charging_profile |
||
|
const |
request |
||
|
type |
object |
||
properties |
||||
|
type |
integer |
||
|
type |
object |
||
properties |
||||
|
type |
string |
||
|
enum |
ChargingStationExternalConstraints, ChargingStationMaxProfile, TxDefaultProfile, TxProfile |
||
|
type |
integer |
Example:
{
"id": "2b0aa109-21a1-4f2f-bdbd-6cdf139e7bb1",
"name": "clear_charging_profile",
"type": "request",
"data": {
"charging_profile_id": 1, [OPTIONAL]
}
}
or
- {
“id”: “2b0aa109-21a1-4f2f-bdbd-6cdf139e7bb1”, “name”: “clear_charging_profile”, “type”: “request”, “data”: {
- “charging_profile_criteria”:{ [OPTIONAL]
“evse_id”: “GB*SEV*123456578”, [OPTIONAL] “charging_profile_purpose”: “TxProfile”, [OPTIONAL] “stack_level”: 2 [OPTIONAL]
},
}
}
ClearChargingProfileResponse¶
Topic: smart_charging/ocpp. Used by Smart Charging service to reply informing about the result of the action. |
||||
type |
object |
|||
properties |
||||
|
type |
string |
||
format |
uuid |
|||
|
const |
clear_charging_profile |
||
|
const |
response |
||
|
type |
object |
||
properties |
||||
|
enum |
accepted, unknown |
||
|
type |
object |
||
properties |
||||
|
type |
string |
||
|
type |
string |
Example:
{
"id": "bb9655e5-21e0-482d-8bc1-67ffdf23539c",
"name": "clear_charging_profile",
"type": "response",
"data": {
"status": "unknown",
}
}