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

   1 {
   2   "$schema": "http://json-schema.org/draft-06/schema#",
   3   "$id": "urn:OCPP:Cp:2:2020:3:GetChargingProfilesRequest",
   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     "ChargingLimitSourceEnumType": {
  19       "javaType": "ChargingLimitSourceEnum",
  20       "type": "string",
  21       "additionalProperties": false,
  22       "enum": ["EMS", "Other", "SO", "CSO"]
  23     },
  24     "ChargingProfilePurposeEnumType": {
  25       "description": "Charging_ Profile. Charging_ Profile_ Purpose. Charging_ Profile_ Purpose_ Code\r\nurn:x-oca:ocpp:uid:1:569231\r\nDefines the purpose of the schedule transferred by this profile\r\n",
  26       "javaType": "ChargingProfilePurposeEnum",
  27       "type": "string",
  28       "additionalProperties": false,
  29       "enum": [
  30         "ChargingStationExternalConstraints",
  31         "ChargingStationMaxProfile",
  32         "TxDefaultProfile",
  33         "TxProfile"
  34       ]
  35     },
  36     "ChargingProfileCriterionType": {
  37       "description": "Charging_ Profile\r\nurn:x-oca:ocpp:uid:2:233255\r\nA ChargingProfile consists of ChargingSchedule, describing the amount of power or current that can be delivered per time interval.\r\n",
  38       "javaType": "ChargingProfileCriterion",
  39       "type": "object",
  40       "additionalProperties": false,
  41       "properties": {
  42         "customData": {
  43           "$ref": "#/definitions/CustomDataType"
  44         },
  45         "chargingProfilePurpose": {
  46           "$ref": "#/definitions/ChargingProfilePurposeEnumType"
  47         },
  48         "stackLevel": {
  49           "description": "Charging_ Profile. Stack_ Level. Counter\r\nurn:x-oca:ocpp:uid:1:569230\r\nValue determining level in hierarchy stack of profiles. Higher values have precedence over lower values. Lowest level is 0.\r\n",
  50           "type": "integer"
  51         },
  52         "chargingProfileId": {
  53           "description": "List of all the chargingProfileIds requested. Any ChargingProfile that matches one of these profiles will be reported. If omitted, the Charging Station SHALL not filter on chargingProfileId. This field SHALL NOT contain more ids than set in &lt;&lt;configkey-charging-profile-entries,ChargingProfileEntries.maxLimit&gt;&gt;\r\n\r\n",
  54           "type": "array",
  55           "additionalItems": false,
  56           "items": {
  57             "type": "integer"
  58           },
  59           "minItems": 1
  60         },
  61         "chargingLimitSource": {
  62           "description": "For which charging limit sources, charging profiles SHALL be reported. If omitted, the Charging Station SHALL not filter on chargingLimitSource.\r\n",
  63           "type": "array",
  64           "additionalItems": false,
  65           "items": {
  66             "$ref": "#/definitions/ChargingLimitSourceEnumType"
  67           },
  68           "minItems": 1,
  69           "maxItems": 4
  70         }
  71       }
  72     }
  73   },
  74   "type": "object",
  75   "additionalProperties": false,
  76   "properties": {
  77     "customData": {
  78       "$ref": "#/definitions/CustomDataType"
  79     },
  80     "requestId": {
  81       "description": "Reference identification that is to be used by the Charging Station in the &lt;&lt;reportchargingprofilesrequest, ReportChargingProfilesRequest&gt;&gt; when provided.\r\n",
  82       "type": "integer"
  83     },
  84     "evseId": {
  85       "description": "For which EVSE installed charging profiles SHALL be reported. If 0, only charging profiles installed on the Charging Station itself (the grid connection) SHALL be reported. If omitted, all installed charging profiles SHALL be reported.\r\n",
  86       "type": "integer"
  87     },
  88     "chargingProfile": {
  89       "$ref": "#/definitions/ChargingProfileCriterionType"
  90     }
  91   },
  92   "required": ["requestId", "chargingProfile"]
  93 }