@citrineos/base
Version:
The base module for OCPP v2.0.1 including all interfaces. This module is not intended to be used directly, but rather as a dependency for other modules.
83 lines (82 loc) • 3.49 kB
JSON
{
"$id": "ClearChargingProfileRequest",
"comment": "OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License",
"definitions": {
"ChargingProfilePurposeEnumType": {
"description": "Specifies to purpose of the charging profiles that will be cleared, if they meet the other criteria in the request.\r\n",
"javaType": "ChargingProfilePurposeEnum",
"type": "string",
"additionalProperties": false,
"enum": [
"ChargingStationExternalConstraints",
"ChargingStationMaxProfile",
"TxDefaultProfile",
"TxProfile",
"PriorityCharging",
"LocalGeneration"
],
"tsEnumNames": [
"ChargingStationExternalConstraints",
"ChargingStationMaxProfile",
"TxDefaultProfile",
"TxProfile",
"PriorityCharging",
"LocalGeneration"
]
},
"ClearChargingProfileType": {
"description": "A ClearChargingProfileType is a filter for charging profiles to be cleared by ClearChargingProfileRequest.\r\n\r\n",
"javaType": "ClearChargingProfile",
"type": "object",
"additionalProperties": false,
"properties": {
"evseId": {
"description": "Specifies the id of the EVSE for which to clear charging profiles. An evseId of zero (0) specifies the charging profile for the overall Charging Station. Absence of this parameter means the clearing applies to all charging profiles that match the other criteria in the request.\r\n\r\n",
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"chargingProfilePurpose": {
"$ref": "#/definitions/ChargingProfilePurposeEnumType"
},
"stackLevel": {
"description": "Specifies the stackLevel for which charging profiles will be cleared, if they meet the other criteria in the request.\r\n",
"type": "integer",
"minimum": 0,
"maximum": 2147483647
},
"customData": {
"$ref": "#/definitions/CustomDataType"
}
}
},
"CustomDataType": {
"description": "This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.",
"javaType": "CustomData",
"type": "object",
"properties": {
"vendorId": {
"type": "string",
"maxLength": 255
}
},
"required": ["vendorId"]
}
},
"type": "object",
"additionalProperties": false,
"properties": {
"chargingProfileId": {
"description": "The Id of the charging profile to clear.\r\n",
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"chargingProfileCriteria": {
"$ref": "#/definitions/ClearChargingProfileType"
},
"customData": {
"$ref": "#/definitions/CustomDataType"
}
}
}