2 "$schema": "http://json-schema.org/draft-07/schema#",
3 "$id": "urn:OCPP:Cp:2:2020:3:GetVariablesResponse",
4 "$comment": "OCPP 2.0.1 FINAL",
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",
16 "required": ["vendorId"]
18 "AttributeEnumType": {
19 "description": "Attribute type for which value is requested. When absent, default Actual is assumed.\r\n",
20 "javaType": "AttributeEnum",
23 "additionalProperties": false,
24 "enum": ["Actual", "Target", "MinSet", "MaxSet"]
26 "GetVariableStatusEnumType": {
27 "description": "Result status of getting the variable.\r\n\r\n",
28 "javaType": "GetVariableStatusEnum",
30 "additionalProperties": false,
36 "NotSupportedAttributeType"
40 "description": "A physical or logical component\r\n",
41 "javaType": "Component",
43 "additionalProperties": false,
46 "$ref": "#/definitions/CustomDataType"
49 "$ref": "#/definitions/EVSEType"
52 "description": "Name of the component. Name should be taken from the list of standardized component names whenever possible. Case Insensitive. strongly advised to use Camel Case.\r\n",
57 "description": "Name of instance in case the component exists as multiple instances. Case Insensitive. strongly advised to use Camel Case.\r\n",
65 "description": "EVSE\r\nurn:x-oca:ocpp:uid:2:233123\r\nElectric Vehicle Supply Equipment\r\n",
68 "additionalProperties": false,
71 "$ref": "#/definitions/CustomDataType"
74 "description": "Identified_ Object. MRID. Numeric_ Identifier\r\nurn:x-enexis:ecdm:uid:1:569198\r\nEVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.\r\n",
78 "description": "An id to designate a specific connector (on an EVSE) by connector index number.\r\n",
84 "GetVariableResultType": {
85 "description": "Class to hold results of GetVariables request.\r\n",
86 "javaType": "GetVariableResult",
88 "additionalProperties": false,
91 "$ref": "#/definitions/CustomDataType"
93 "attributeStatusInfo": {
94 "$ref": "#/definitions/StatusInfoType"
97 "$ref": "#/definitions/GetVariableStatusEnumType"
100 "$ref": "#/definitions/AttributeEnumType"
103 "description": "Value of requested attribute type of component-variable. This field can only be empty when the given status is NOT accepted.\r\n\r\nThe Configuration Variable <<configkey-reporting-value-size,ReportingValueSize>> can be used to limit GetVariableResult.attributeValue, VariableAttribute.value and EventData.actualValue. The max size of these values will always remain equal. \r\n\r\n",
108 "$ref": "#/definitions/ComponentType"
111 "$ref": "#/definitions/VariableType"
114 "required": ["attributeStatus", "component", "variable"]
117 "description": "Element providing more information about the status.\r\n",
118 "javaType": "StatusInfo",
120 "additionalProperties": false,
123 "$ref": "#/definitions/CustomDataType"
126 "description": "A predefined code for the reason why the status is returned in this response. The string is case-insensitive.\r\n",
131 "description": "Additional text to provide detailed information.\r\n",
136 "required": ["reasonCode"]
139 "description": "Reference key to a component-variable.\r\n",
140 "javaType": "Variable",
142 "additionalProperties": false,
145 "$ref": "#/definitions/CustomDataType"
148 "description": "Name of the variable. Name should be taken from the list of standardized variable names whenever possible. Case Insensitive. strongly advised to use Camel Case.\r\n",
153 "description": "Name of instance in case the variable exists as multiple instances. Case Insensitive. strongly advised to use Camel Case.\r\n",
162 "additionalProperties": false,
165 "$ref": "#/definitions/CustomDataType"
167 "getVariableResult": {
169 "additionalItems": false,
171 "$ref": "#/definitions/GetVariableResultType"
176 "required": ["getVariableResult"]