| 1 | { |
| 2 | "$schema": "http://json-schema.org/draft-07/schema#", |
| 3 | "$id": "urn:OCPP:Cp:2:2020:3:GetDisplayMessagesRequest", |
| 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 | "MessagePriorityEnumType": { |
| 19 | "description": "If provided the Charging Station shall return Display Messages with the given priority only.\r\n", |
| 20 | "javaType": "MessagePriorityEnum", |
| 21 | "type": "string", |
| 22 | "additionalProperties": false, |
| 23 | "enum": ["AlwaysFront", "InFront", "NormalCycle"] |
| 24 | }, |
| 25 | "MessageStateEnumType": { |
| 26 | "description": "If provided the Charging Station shall return Display Messages with the given state only. \r\n", |
| 27 | "javaType": "MessageStateEnum", |
| 28 | "type": "string", |
| 29 | "additionalProperties": false, |
| 30 | "enum": ["Charging", "Faulted", "Idle", "Unavailable"] |
| 31 | } |
| 32 | }, |
| 33 | "type": "object", |
| 34 | "additionalProperties": false, |
| 35 | "properties": { |
| 36 | "customData": { |
| 37 | "$ref": "#/definitions/CustomDataType" |
| 38 | }, |
| 39 | "id": { |
| 40 | "description": "If provided the Charging Station shall return Display Messages of the given ids. This field SHALL NOT contain more ids than set in <<configkey-number-of-display-messages,NumberOfDisplayMessages.maxLimit>>\r\n\r\n", |
| 41 | "type": "array", |
| 42 | "additionalItems": false, |
| 43 | "items": { |
| 44 | "type": "integer" |
| 45 | }, |
| 46 | "minItems": 1 |
| 47 | }, |
| 48 | "requestId": { |
| 49 | "description": "The Id of this request.\r\n", |
| 50 | "type": "integer" |
| 51 | }, |
| 52 | "priority": { |
| 53 | "$ref": "#/definitions/MessagePriorityEnumType" |
| 54 | }, |
| 55 | "state": { |
| 56 | "$ref": "#/definitions/MessageStateEnumType" |
| 57 | } |
| 58 | }, |
| 59 | "required": ["requestId"] |
| 60 | } |