src/assets/json-schemas/ocpp/2.0/ClearChargingProfileRequest.json

   1 {
   2   "$schema": "http://json-schema.org/draft-07/schema#",
   3   "$id": "urn:OCPP:Cp:2:2020:3:ClearChargingProfileRequest",
   4   "$comment": "OCPP 2.0.1 FINAL",
   5   "definitions": {
   6     "CustomDataType": {
   7       "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.",
   8       "javaType": "CustomData",
   9       "type": "object",
  10       "properties": {
  11         "vendorId": {
  12           "type": "string",
  13           "maxLength": 255
  14         }
  15       },
  16       "required": ["vendorId"]
  17     },
  18     "ChargingProfilePurposeEnumType": {
  19       "description": "Charging_ Profile. Charging_ Profile_ Purpose. Charging_ Profile_ Purpose_ Code\r\nurn:x-oca:ocpp:uid:1:569231\r\nSpecifies to purpose of the charging profiles that will be cleared, if they meet the other criteria in the request.\r\n",
  20       "javaType": "ChargingProfilePurposeEnum",
  21       "type": "string",
  22       "additionalProperties": false,
  23       "enum": [
  24         "ChargingStationExternalConstraints",
  25         "ChargingStationMaxProfile",
  26         "TxDefaultProfile",
  27         "TxProfile"
  28       ]
  29     },
  30     "ClearChargingProfileType": {
  31       "description": "Charging_ Profile\r\nurn:x-oca:ocpp:uid:2:233255\r\nA ChargingProfile consists of a ChargingSchedule, describing the amount of power or current that can be delivered per time interval.\r\n",
  32       "javaType": "ClearChargingProfile",
  33       "type": "object",
  34       "additionalProperties": false,
  35       "properties": {
  36         "customData": {
  37           "$ref": "#/definitions/CustomDataType"
  38         },
  39         "evseId": {
  40           "description": "Identified_ Object. MRID. Numeric_ Identifier\r\nurn:x-enexis:ecdm:uid:1:569198\r\nSpecifies 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",
  41           "type": "integer"
  42         },
  43         "chargingProfilePurpose": {
  44           "$ref": "#/definitions/ChargingProfilePurposeEnumType"
  45         },
  46         "stackLevel": {
  47           "description": "Charging_ Profile. Stack_ Level. Counter\r\nurn:x-oca:ocpp:uid:1:569230\r\nSpecifies the stackLevel for which charging profiles will be cleared, if they meet the other criteria in the request.\r\n",
  48           "type": "integer"
  49         }
  50       }
  51     }
  52   },
  53   "type": "object",
  54   "additionalProperties": false,
  55   "properties": {
  56     "customData": {
  57       "$ref": "#/definitions/CustomDataType"
  58     },
  59     "chargingProfileId": {
  60       "description": "The Id of the charging profile to clear.\r\n",
  61       "type": "integer"
  62     },
  63     "chargingProfileCriteria": {
  64       "$ref": "#/definitions/ClearChargingProfileType"
  65     }
  66   }
  67 }