Get Base Report

Source: OCPP 2.0.1 Part 2 — Specification (Edition 2, 2022-12-15) — Section 1.17 (Messages); Use Case B07 — Get Base Report (Functional Block B. Provisioning)

Overview

The CSMS sends GetBaseReportRequest to ask the Charging Station for a "base" Device Model report — typically ConfigurationInventory (writable variables), FullInventory (everything), SummaryInventory, or ReportBase.

The CS responds first with GetBaseReportResponse(status) and then delivers the actual report data via one or more NotifyReport messages, sharing the same requestId.

Sequence Diagram

CSMS  ──── GetBaseReportRequest ────▶  Charging Station
            (requestId, reportBase)
CSMS  ◀─── GetBaseReportResponse ────  Charging Station
            (status, statusInfo?)

(then one or more NotifyReportRequest with same requestId)

Initiator

CSMS → Charging Station

Fields

ReportBaseEnumType values

• ConfigurationInventory — All Variables that are writable / settable.
• FullInventory — All Variables (regardless of mutability).
• SummaryInventory — A summary report (vendor-defined subset).

GenericDeviceModelStatusEnumType values

Accepted, Rejected, NotSupported, EmptyResultSet.

Examples

{
  "requestId": 11,
  "reportBase": "FullInventory"
}

{
  "status": "Accepted"
}

Schema

Source: schemas/GetBaseReportRequest.json, schemas/GetBaseReportResponse.json (OCPP 2.0.1 FINAL)