Get Charging Profiles

Source: OCPP 2.0.1 Part 2 — Specification (Edition 2, 2022-12-15) — Section 1.19 (Messages); Use Case K09 — Get Charging Profiles (Functional Block K. SmartCharging)

Overview

The CSMS sends GetChargingProfilesRequest to ask the Charging Station to report the charging profiles it currently has installed. The CS responds with GetChargingProfilesResponse(status) and then delivers the actual profile data through one or more ReportChargingProfiles messages sharing the same requestId.

If evseId = 0 (or omitted), only profiles for the whole Charging Station / grid connection are reported. The optional chargingProfile criteria narrows down by id, source, purpose, or stack level.

Sequence Diagram

CSMS  ──── GetChargingProfilesRequest ────▶  Charging Station
            (requestId, evseId?, chargingProfile)
CSMS  ◀─── GetChargingProfilesResponse ────  Charging Station
            (status, statusInfo?)

(then one or more ReportChargingProfilesRequest with same requestId)

Initiator

CSMS → Charging Station

Fields

Field Name	Field Type	Card.	Description
requestId	integer	1..1	Required. Reference id used by the CS in `ReportChargingProfiles`.
evseId	integer	0..1	Optional. EVSE filter. `0` reports only Charging Station-level profiles. Omitted reports all.
chargingProfile	ChargingProfileCriterionType	1..1	Required. Selection criteria for the profiles.

ChargingProfileCriterionType (selected fields)

Field	Type	Card.	Description
chargingProfilePurpose	ChargingProfilePurposeEnumType	0..1	Filter by purpose.
stackLevel	integer	0..1	Filter by stack level.
chargingProfileId	integer	0..*	List of profile ids to filter by.
chargingLimitSource	ChargingLimitSourceEnumType	0..*	Filter by source: `EMS`/`Other`/`SO`/`CSO`.

GetChargingProfileStatusEnumType values

Accepted, NoProfiles.

Examples

{
  "requestId": 99,
  "evseId": 1,
  "chargingProfile": {
    "chargingProfilePurpose": "TxProfile",
    "chargingLimitSource": ["CSO"]
  }
}

{
  "status": "Accepted"
}

Schema

Source: schemas/GetChargingProfilesRequest.json, schemas/GetChargingProfilesResponse.json (OCPP 2.0.1 FINAL)

Request schema (JSON Schema)

Response schema (JSON Schema)

Field Name	Field Type	Card.	Description
status	GetChargingProfileStatusEnumType	1..1	Required. Whether the CS can process this request.
statusInfo	StatusInfoType	0..1	Optional. Detailed status information.