Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Charge Points Charging Rules

Retrieve a single charge point charging rule

Required scope: charge-points:read </br>Organization authorization: supported

get/api/v1/charge-points/{chargePointId}/charging-rules/{chargingRuleId}

Path parameters

chargePointIdinteger required
chargingRuleIdinteger required

Response

Charge point charging rule with provided id

idinteger

Id of this charging rule

namestring required

Name of the charging rule

type'smart_charge' | 'scheduled' | 'instant' required

Types of Charge Point Charging Rules

isActiveboolean required

Indicates if this rule is active

isSponsoredboolean required

Indicates if the charge is sponsored

creatorUserIdinteger required

User that created this rule

vehicleIdinteger nullable

Vehicle id of the vehicle this rule applies to

supportedChargingRuleTypesChargingRuleType[] required

The type of charging rules supported by this charge point

Example response

{
  "id": 1,
  "name": "Smart charging rule",
  "isActive": true,
  "isSponsored": true,
  "creatorUserId": 123,
  "vehicleId": 123,
  "settings": {
    "start": "22:00",
    "beReadyAt": "06:00",
    "defaultMaxBatteryPercentage": 80
  }
}