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

   1 {
   2   "$schema": "http://json-schema.org/draft-06/schema#",
   3   "$id": "urn:OCPP:Cp:2:2020:3:SetDisplayMessageRequest",
   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     "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",
  21       "type": "string",
  22       "additionalProperties": false,
  23       "enum": ["ASCII", "HTML", "URI", "UTF8"]
  24     },
  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",
  28       "type": "string",
  29       "additionalProperties": false,
  30       "enum": ["AlwaysFront", "InFront", "NormalCycle"]
  31     },
  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",
  35       "type": "string",
  36       "additionalProperties": false,
  37       "enum": ["Charging", "Faulted", "Idle", "Unavailable"]
  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 (&gt; 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     "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",
  87       "type": "object",
  88       "additionalProperties": false,
  89       "properties": {
  90         "customData": {
  91           "$ref": "#/definitions/CustomDataType"
  92         },
  93         "format": {
  94           "$ref": "#/definitions/MessageFormatEnumType"
  95         },
  96         "language": {
  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 &lt;&lt;ref-RFC5646,[RFC5646]&gt;&gt;.\r\n",
  98           "type": "string",
  99           "maxLength": 8
 100         },
 101         "content": {
 102           "description": "Message_ Content. Content. Message\r\nurn:x-enexis:ecdm:uid:1:570852\r\nMessage contents.\r\n\r\n",
 103           "type": "string",
 104           "maxLength": 512
 105         }
 106       },
 107       "required": ["format", "content"]
 108     },
 109     "MessageInfoType": {
 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",
 112       "type": "object",
 113       "additionalProperties": false,
 114       "properties": {
 115         "customData": {
 116           "$ref": "#/definitions/CustomDataType"
 117         },
 118         "display": {
 119           "$ref": "#/definitions/ComponentType"
 120         },
 121         "id": {
 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",
 123           "type": "integer"
 124         },
 125         "priority": {
 126           "$ref": "#/definitions/MessagePriorityEnumType"
 127         },
 128         "state": {
 129           "$ref": "#/definitions/MessageStateEnumType"
 130         },
 131         "startDateTime": {
 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",
 133           "type": "string",
 134           "format": "date-time"
 135         },
 136         "endDateTime": {
 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",
 138           "type": "string",
 139           "format": "date-time"
 140         },
 141         "transactionId": {
 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",
 143           "type": "string",
 144           "maxLength": 36
 145         },
 146         "message": {
 147           "$ref": "#/definitions/MessageContentType"
 148         }
 149       },
 150       "required": ["id", "priority", "message"]
 151     }
 152   },
 153   "type": "object",
 154   "additionalProperties": false,
 155   "properties": {
 156     "customData": {
 157       "$ref": "#/definitions/CustomDataType"
 158     },
 159     "message": {
 160       "$ref": "#/definitions/MessageInfoType"
 161     }
 162   },
 163   "required": ["message"]
 164 }