| 1 | { |
| 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", |
| 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 | "AttributeEnumType": { |
| 19 | "description": "Attribute type for which value is requested. When absent, default Actual is assumed.\r\n", |
| 20 | "javaType": "AttributeEnum", |
| 21 | "type": "string", |
| 22 | "default": "Actual", |
| 23 | "additionalProperties": false, |
| 24 | "enum": ["Actual", "Target", "MinSet", "MaxSet"] |
| 25 | }, |
| 26 | "GetVariableStatusEnumType": { |
| 27 | "description": "Result status of getting the variable.\r\n\r\n", |
| 28 | "javaType": "GetVariableStatusEnum", |
| 29 | "type": "string", |
| 30 | "additionalProperties": false, |
| 31 | "enum": [ |
| 32 | "Accepted", |
| 33 | "Rejected", |
| 34 | "UnknownComponent", |
| 35 | "UnknownVariable", |
| 36 | "NotSupportedAttributeType" |
| 37 | ] |
| 38 | }, |
| 39 | "ComponentType": { |
| 40 | "description": "A physical or logical component\r\n", |
| 41 | "javaType": "Component", |
| 42 | "type": "object", |
| 43 | "additionalProperties": false, |
| 44 | "properties": { |
| 45 | "customData": { |
| 46 | "$ref": "#/definitions/CustomDataType" |
| 47 | }, |
| 48 | "evse": { |
| 49 | "$ref": "#/definitions/EVSEType" |
| 50 | }, |
| 51 | "name": { |
| 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", |
| 53 | "type": "string", |
| 54 | "maxLength": 50 |
| 55 | }, |
| 56 | "instance": { |
| 57 | "description": "Name of instance in case the component exists as multiple instances. Case Insensitive. strongly advised to use Camel Case.\r\n", |
| 58 | "type": "string", |
| 59 | "maxLength": 50 |
| 60 | } |
| 61 | }, |
| 62 | "required": ["name"] |
| 63 | }, |
| 64 | "EVSEType": { |
| 65 | "description": "EVSE\r\nurn:x-oca:ocpp:uid:2:233123\r\nElectric Vehicle Supply Equipment\r\n", |
| 66 | "javaType": "EVSE", |
| 67 | "type": "object", |
| 68 | "additionalProperties": false, |
| 69 | "properties": { |
| 70 | "customData": { |
| 71 | "$ref": "#/definitions/CustomDataType" |
| 72 | }, |
| 73 | "id": { |
| 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", |
| 75 | "type": "integer" |
| 76 | }, |
| 77 | "connectorId": { |
| 78 | "description": "An id to designate a specific connector (on an EVSE) by connector index number.\r\n", |
| 79 | "type": "integer" |
| 80 | } |
| 81 | }, |
| 82 | "required": ["id"] |
| 83 | }, |
| 84 | "GetVariableResultType": { |
| 85 | "description": "Class to hold results of GetVariables request.\r\n", |
| 86 | "javaType": "GetVariableResult", |
| 87 | "type": "object", |
| 88 | "additionalProperties": false, |
| 89 | "properties": { |
| 90 | "customData": { |
| 91 | "$ref": "#/definitions/CustomDataType" |
| 92 | }, |
| 93 | "attributeStatusInfo": { |
| 94 | "$ref": "#/definitions/StatusInfoType" |
| 95 | }, |
| 96 | "attributeStatus": { |
| 97 | "$ref": "#/definitions/GetVariableStatusEnumType" |
| 98 | }, |
| 99 | "attributeType": { |
| 100 | "$ref": "#/definitions/AttributeEnumType" |
| 101 | }, |
| 102 | "attributeValue": { |
| 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", |
| 104 | "type": "string", |
| 105 | "maxLength": 2500 |
| 106 | }, |
| 107 | "component": { |
| 108 | "$ref": "#/definitions/ComponentType" |
| 109 | }, |
| 110 | "variable": { |
| 111 | "$ref": "#/definitions/VariableType" |
| 112 | } |
| 113 | }, |
| 114 | "required": ["attributeStatus", "component", "variable"] |
| 115 | }, |
| 116 | "StatusInfoType": { |
| 117 | "description": "Element providing more information about the status.\r\n", |
| 118 | "javaType": "StatusInfo", |
| 119 | "type": "object", |
| 120 | "additionalProperties": false, |
| 121 | "properties": { |
| 122 | "customData": { |
| 123 | "$ref": "#/definitions/CustomDataType" |
| 124 | }, |
| 125 | "reasonCode": { |
| 126 | "description": "A predefined code for the reason why the status is returned in this response. The string is case-insensitive.\r\n", |
| 127 | "type": "string", |
| 128 | "maxLength": 20 |
| 129 | }, |
| 130 | "additionalInfo": { |
| 131 | "description": "Additional text to provide detailed information.\r\n", |
| 132 | "type": "string", |
| 133 | "maxLength": 512 |
| 134 | } |
| 135 | }, |
| 136 | "required": ["reasonCode"] |
| 137 | }, |
| 138 | "VariableType": { |
| 139 | "description": "Reference key to a component-variable.\r\n", |
| 140 | "javaType": "Variable", |
| 141 | "type": "object", |
| 142 | "additionalProperties": false, |
| 143 | "properties": { |
| 144 | "customData": { |
| 145 | "$ref": "#/definitions/CustomDataType" |
| 146 | }, |
| 147 | "name": { |
| 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", |
| 149 | "type": "string", |
| 150 | "maxLength": 50 |
| 151 | }, |
| 152 | "instance": { |
| 153 | "description": "Name of instance in case the variable exists as multiple instances. Case Insensitive. strongly advised to use Camel Case.\r\n", |
| 154 | "type": "string", |
| 155 | "maxLength": 50 |
| 156 | } |
| 157 | }, |
| 158 | "required": ["name"] |
| 159 | } |
| 160 | }, |
| 161 | "type": "object", |
| 162 | "additionalProperties": false, |
| 163 | "properties": { |
| 164 | "customData": { |
| 165 | "$ref": "#/definitions/CustomDataType" |
| 166 | }, |
| 167 | "getVariableResult": { |
| 168 | "type": "array", |
| 169 | "additionalItems": false, |
| 170 | "items": { |
| 171 | "$ref": "#/definitions/GetVariableResultType" |
| 172 | }, |
| 173 | "minItems": 1 |
| 174 | } |
| 175 | }, |
| 176 | "required": ["getVariableResult"] |
| 177 | } |