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