Get Display Messages

Source: OCPP 2.0.1 Part 2 — Specification (Edition 2, 2022-12-15) — Section 1.21 (Messages); Use Cases O03 — Get All DisplayMessages, O04 — Get Specific DisplayMessages (Functional Block O. DisplayMessage)

Overview

The CSMS sends GetDisplayMessagesRequest to ask the Charging Station to report its currently-configured display messages. Filters by id, priority, and state narrow the result. The actual message data is delivered through one or more NotifyDisplayMessages messages sharing the same requestId.

The number of id values per request must not exceed NumberOfDisplayMessages.maxLimit.

Sequence Diagram

CSMS  ──── GetDisplayMessagesRequest ────▶  Charging Station
            (requestId, id[]?, priority?, state?)
CSMS  ◀─── GetDisplayMessagesResponse ────  Charging Station
            (status, statusInfo?)

(then zero or more NotifyDisplayMessagesRequest with same requestId)

Initiator

CSMS → Charging Station

Fields

Field Name	Field Type	Card.	Description
id	integer	0..*	Optional. Specific message ids to return.
requestId	integer	1..1	Required. Id of the request.
priority	MessagePriorityEnumType	0..1	Optional. Filter by priority.
state	MessageStateEnumType	0..1	Optional. Filter by message state.

GetDisplayMessagesStatusEnumType values

Accepted, Unknown.

MessagePriorityEnumType values

AlwaysFront, InFront, NormalCycle.

MessageStateEnumType values

Charging, Faulted, Idle, Unavailable.

Examples

{
  "requestId": 88,
  "priority": "InFront"
}

{
  "status": "Accepted"
}

Schema

Source: schemas/GetDisplayMessagesRequest.json, schemas/GetDisplayMessagesResponse.json (OCPP 2.0.1 FINAL)

Request schema (JSON Schema)

Response schema (JSON Schema)

Field Name	Field Type	Card.	Description
status	GetDisplayMessagesStatusEnumType	1..1	Required. Whether messages match the request criteria.
statusInfo	StatusInfoType	0..1	Optional. Detailed status information.