2 "$schema": "http://json-schema.org/draft-07/schema#",
3 "$id": "urn:OCPP:Cp:2:2020:3:NotifyDisplayMessagesRequest",
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 "MessageFormatEnumType": {
19 "description": "Message_ Content. Format. Message_ Format_ Code\r\nurn:x-enexis:ecdm:uid:1:570848\r\nFormat of the message.\r\n",
20 "javaType": "MessageFormatEnum",
22 "additionalProperties": false,
23 "enum": ["ASCII", "HTML", "URI", "UTF8"]
25 "MessagePriorityEnumType": {
26 "description": "Message_ Info. Priority. Message_ Priority_ Code\r\nurn:x-enexis:ecdm:uid:1:569253\r\nWith what priority should this message be shown\r\n",
27 "javaType": "MessagePriorityEnum",
29 "additionalProperties": false,
30 "enum": ["AlwaysFront", "InFront", "NormalCycle"]
32 "MessageStateEnumType": {
33 "description": "Message_ Info. State. Message_ State_ Code\r\nurn:x-enexis:ecdm:uid:1:569254\r\nDuring what state should this message be shown. When omitted this message should be shown in any state of the Charging Station.\r\n",
34 "javaType": "MessageStateEnum",
36 "additionalProperties": false,
37 "enum": ["Charging", "Faulted", "Idle", "Unavailable"]
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 "MessageContentType": {
85 "description": "Message_ Content\r\nurn:x-enexis:ecdm:uid:2:234490\r\nContains message details, for a message to be displayed on a Charging Station.\r\n\r\n",
86 "javaType": "MessageContent",
88 "additionalProperties": false,
91 "$ref": "#/definitions/CustomDataType"
94 "$ref": "#/definitions/MessageFormatEnumType"
97 "description": "Message_ Content. Language. Language_ Code\r\nurn:x-enexis:ecdm:uid:1:570849\r\nMessage language identifier. Contains a language code as defined in <<ref-RFC5646,[RFC5646]>>.\r\n",
102 "description": "Message_ Content. Content. Message\r\nurn:x-enexis:ecdm:uid:1:570852\r\nMessage contents.\r\n\r\n",
107 "required": ["format", "content"]
110 "description": "Message_ Info\r\nurn:x-enexis:ecdm:uid:2:233264\r\nContains message details, for a message to be displayed on a Charging Station.\r\n",
111 "javaType": "MessageInfo",
113 "additionalProperties": false,
116 "$ref": "#/definitions/CustomDataType"
119 "$ref": "#/definitions/ComponentType"
122 "description": "Identified_ Object. MRID. Numeric_ Identifier\r\nurn:x-enexis:ecdm:uid:1:569198\r\nMaster resource identifier, unique within an exchange context. It is defined within the OCPP context as a positive Integer value (greater or equal to zero).\r\n",
126 "$ref": "#/definitions/MessagePriorityEnumType"
129 "$ref": "#/definitions/MessageStateEnumType"
132 "description": "Message_ Info. Start. Date_ Time\r\nurn:x-enexis:ecdm:uid:1:569256\r\nFrom what date-time should this message be shown. If omitted: directly.\r\n",
134 "format": "date-time"
137 "description": "Message_ Info. End. Date_ Time\r\nurn:x-enexis:ecdm:uid:1:569257\r\nUntil what date-time should this message be shown, after this date/time this message SHALL be removed.\r\n",
139 "format": "date-time"
142 "description": "During which transaction shall this message be shown.\r\nMessage SHALL be removed by the Charging Station after transaction has\r\nended.\r\n",
147 "$ref": "#/definitions/MessageContentType"
150 "required": ["id", "priority", "message"]
154 "additionalProperties": false,
157 "$ref": "#/definitions/CustomDataType"
161 "additionalItems": false,
163 "$ref": "#/definitions/MessageInfoType"
168 "description": "The id of the <<getdisplaymessagesrequest,GetDisplayMessagesRequest>> that requested this message.\r\n",
172 "description": "\"to be continued\" indicator. Indicates whether another part of the report follows in an upcoming NotifyDisplayMessagesRequest message. Default value when omitted is false.\r\n",
177 "required": ["requestId"]