OCPP 2.1 Schemas — Display

Functional Block: O

Types Reference: Shared types referenced below are defined in OCPP-2.1-DataTypes.md.
Types used only within this block are documented inline below.

#Messages

SetDisplayMessage (CSMS → CS)
GetDisplayMessages (CSMS → CS)
ClearDisplayMessage (CSMS → CS)
NotifyDisplayMessages (CS → CSMS)

#SetDisplayMessage

Direction: CSMS → CS

#SetDisplayMessageRequest

Field	Type	Required	Constraints	Description
`message`	MessageInfoType	Yes
`customData`	CustomDataType	No

Example SetDisplayMessageRequest

{
  "message": {
    "id": 0,
    "priority": "AlwaysFront",
    "message": {
      "format": "ASCII",
      "content": "string"
    }
  }
}

#SetDisplayMessageResponse

Field	Type	Required
`status`	DisplayMessageStatusEnumType	Yes
`statusInfo`	StatusInfoType	No
`customData`	CustomDataType	No

#GetDisplayMessages

Direction: CSMS → CS

#GetDisplayMessagesRequest

Field	Type	Required	Constraints	Description
`requestId`	integer	Yes		The Id of this request.
`id`	integer[]	No	minItems: 1	If provided the Charging Station shall return Display Messages of the given ids. This field SHALL NOT contain more ids than set in NumberOfDisplayMessages.maxLimit
`priority`	MessagePriorityEnumType	No
`state`	MessageStateEnumType	No
`customData`	CustomDataType	No

Example GetDisplayMessagesRequest

{
  "requestId": 0
}

#GetDisplayMessagesResponse

Field	Type	Required
`status`	GetDisplayMessagesStatusEnumType	Yes
`statusInfo`	StatusInfoType	No
`customData`	CustomDataType	No

#ClearDisplayMessage

Direction: CSMS → CS

#ClearDisplayMessageRequest

Field	Type	Required	Constraints	Description
`id`	integer	Yes	min: 0.0	Id of the message that SHALL be removed from the Charging Station.
`customData`	CustomDataType	No

Example ClearDisplayMessageRequest

{
  "id": 0
}

#ClearDisplayMessageResponse

Field	Type	Required
`status`	ClearMessageStatusEnumType	Yes
`statusInfo`	StatusInfoType	No
`customData`	CustomDataType	No

#NotifyDisplayMessages

Direction: CS → CSMS

#NotifyDisplayMessagesRequest

Field	Type	Required	Constraints	Description
`requestId`	integer	Yes		The id of the GetDisplayMessagesRequest that requested this message.
`messageInfo`	MessageInfoType[]	No	minItems: 1
`tbc`	boolean	No		"to be continued" indicator. Indicates whether another part of the report follows in an upcoming NotifyDisplayMessagesRequest message. Default value when omitted is false. Default: `False`
`customData`	CustomDataType	No

Example NotifyDisplayMessagesRequest

{
  "requestId": 0
}

#NotifyDisplayMessagesResponse

No required fields. An empty {} is a valid response.

#Local Types

Types used only within this block's messages.

#ClearMessageStatusEnumType

Returns whether the Charging Station has been able to remove the message.

Value
`Accepted`
`Unknown`
`Rejected`

Used in: ClearDisplayMessage

#DisplayMessageStatusEnumType

This indicates whether the Charging Station is able to display the message.

Value
`Accepted`
`NotSupportedMessageFormat`
`Rejected`
`NotSupportedPriority`
`NotSupportedState`
`UnknownTransaction`
`LanguageNotSupported`

Used in: SetDisplayMessage

#GetDisplayMessagesStatusEnumType

Indicates if the Charging Station has Display Messages that match the request criteria in the GetDisplayMessagesRequest

Value
`Accepted`
`Unknown`

Used in: GetDisplayMessages

#MessageInfoType

Contains message details, for a message to be displayed on a Charging Station.

Field	Type	Required	Constraints	Description
`id`	integer	Yes	min: 0.0	Unique id within an exchange context. It is defined within the OCPP context as a positive Integer value (greater or equal to zero).
`message`	MessageContentType	Yes
`priority`	MessagePriorityEnumType	Yes
`display`	ComponentType	No
`endDateTime`	string (date-time)	No		Until what date-time should this message be shown, after this date/time this message SHALL be removed.
`messageExtra`	MessageContentType[]	No	minItems: 1, maxItems: 4
`startDateTime`	string (date-time)	No		From what date-time should this message be shown. If omitted: directly.
`state`	MessageStateEnumType	No
`transactionId`	string	No	maxLength: 36	ended.
`customData`	CustomDataType	No

Used in: NotifyDisplayMessages, SetDisplayMessage