---
title: "Get Example Ocpp Charging Profile"
method: GET
path: "/examples/ocpp-charging-profile"
tags: ["8. Examples"]
---

# Get Example Ocpp Charging Profile

`GET /examples/ocpp-charging-profile`

Get an example OCPP charging profile.

Returns a pre-filled SetChargingProfileRequest object that can be used as a reference for the expected format and structure of OCPP charging profiles.

## Response `200`

Example OCPP charging profile

- SetChargingProfileRequest — A SetChargingProfileRequest object, as defined in section 6.43 of the OCPP 1.6 documentation at https://openchargealliance.org/protocols/open-charge-point-protocol/#OCPP1.6 This is used by the central system to send charging profiles to an EV charger.
  - `connectorId` integer, required — The connector to which the charging profile applies. If connectorId = 0, the message contains an overall limit for the Charge Point.
  - `csChargingProfiles` ChargingProfile, required — A ChargingProfile consists of a ChargingSchedule, describing the amount of power or current that can be delivered per time interval.
    - `chargingProfileId` integer, required — Unique identifier for this profile.
    - `transactionId` integer — Only valid if ChargingProfilePurpose is set to TxProfile, the transactionId MAY be used to match the profile to a specific transaction.
    - `stackLevel` integer, required — Value determining level in hierarchy stack of profiles. Higher values have precedence over lower values. Lowest level is 0.
    - `chargingProfilePurpose` 'ChargePointMaxProfile' | 'TxDefaultProfile' | 'TxProfile', required — Purpose of the charging profile ChargePointMaxProfile: Configuration for the maximum power or current available for an entire Charge Point. TxDefaultProfile: Default profile that can be configured in the Charge Point. When a new transaction is started, this profile SHALL be used, unless it was a transaction that was started by a RemoteStartTransaction.req with a ChargeProfile that is accepted by the Charge Point. TxProfile: Profile with constraints to be imposed by the Charge Point on the current transaction, or on a new transaction when this is started via a RemoteStartTransaction.req with a ChargeProfile. A profile with this purpose SHALL cease to be valid when the transaction terminates.
    - `chargingProfileKind` 'Absolute' | 'Recurring' | 'Relative', required — Kind of charging profile Absolute: Schedule periods are relative to a fixed point in time defined in the schedule. Recurring: The schedule restarts periodically at the first schedule period. Relative: Schedule periods are relative to a situation-specific start point (such as the start of a Transaction) that is determined by the charge point.
    - `recurrencyKind` 'Daily' | 'Weekly' — Type of recurrence of a charging profile Daily: The schedule restarts every 24 hours, at the same time as in the startSchedule. Weekly: The schedule restarts every 7 days, at the same time and day-of-the-week as in the startSchedule.
    - `validFrom` string, date-time — Point in time at which the profile starts to be valid. If absent, the profile is valid as soon as it is received by the Charge Point.
    - `validTo` string, date-time — Point in time at which the profile stops to be valid. If absent, the profile is valid until it is replaced by another profile.
    - `chargingSchedule` ChargingSchedule, required — Charging schedule structure defines a list of charging periods
      - `duration` integer — Duration of the charging schedule in seconds. If the duration is left empty, the last period will continue indefinitely or until end of the transaction in case startSchedule is absent.
      - `startSchedule` string, date-time — Starting point of an absolute schedule. If absent the schedule will be relative to start of charging.
      - `chargingRateUnit` 'W' | 'A', required — Unit in which a charging schedule is defined W: Watts (power). This is the TOTAL allowed charging power. It is usually more convenient to use this for DC charging. A: Amperes (current). The amount of Ampere per phase, not the sum of all phases. It is usually more convenient to use this for AC charging.
      - `chargingSchedulePeriod` ChargingSchedulePeriod[], required — List of ChargingSchedulePeriod elements defining maximum power or current usage over time. The startSchedule of the first ChargingSchedulePeriod SHALL always be 0.
        - `startPeriod` integer, required — Start of the period, in seconds from the start of schedule. The value of StartPeriod also defines the stop time of the previous period.
        - `limit` number, required — Charging rate limit during the schedule period, in the applicable chargingRateUnit, for example in Amperes or Watts. Accepts at most one digit fraction (e.g. 8.1).
        - `numberPhases` integer — The number of phases that can be used for charging. If a number of phases is needed, numberPhases=3 will be assumed unless another number is given.
      - `minChargingRate` number — Minimum charging rate supported by the electric vehicle. The unit of measure is defined by the chargingRateUnit. This parameter is intended to be used by a local smart charging algorithm to optimize the power allocation for in the case a charging process is inefficient at lower charging rates. Accepts at most one digit fraction (e.g. 8.1)

## Other responses

- `500` — Server error while generating example

---

[API](https://skmtc.dev/axle/apis/axle-api-docs.md) · [All operations](https://skmtc.dev/axle/apis/axle-api-docs/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/axle/axle-api-docs/revisions/75be7f9a952f/schema)