Clear Display Message

Name: OCPPLab
Availability: InStock

Source: OCPP 2.0.1 Part 2 — Specification (Edition 2, 2022-12-15) — Section 1.8 (Messages); Use Case O05 — Clear a DisplayMessage (Functional Block O. DisplayMessage)

Overview

The CSMS sends ClearDisplayMessageRequest to ask the Charging Station to remove a previously-configured display message identified by id.

Sequence Diagram

CSMS  ──── ClearDisplayMessageRequest ────▶  Charging Station
            (id)
CSMS  ◀─── ClearDisplayMessageResponse ────  Charging Station
            (status, statusInfo?)

Initiator

CSMS → Charging Station

Fields

Field Name	Field Type	Card.	Description
id	integer	1..1	Required. Id of the message to be removed.

ClearMessageStatusEnumType values

Accepted, Unknown.

Examples

{
  "id": 1
}

{
  "status": "Accepted"
}

Schema

Source: schemas/ClearDisplayMessageRequest.json, schemas/ClearDisplayMessageResponse.json (OCPP 2.0.1 FINAL)

Request schema (JSON Schema)

Response schema (JSON Schema)

Field Name	Field Type	Card.	Description
status	ClearMessageStatusEnumType	1..1	Required. Whether the CS has been able to remove the message.
statusInfo	StatusInfoType	0..1	Optional. Detailed status information.