MOmonta
Charge Points Charging Rules

Retrieve a single charge point charging rule

Changed on

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

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

Request

  • Base URL
    https://partner-api.monta.com
  • URL
    https://partner-api.monta.com/api/v1/charge-points/{chargePointId}/charging-rules/{chargingRuleId}
  • Auth
    HTTP bearer

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

chargePointIdinteger nullable

Id of the charge point this rule belongs to

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
  },
  "chargePointId": 123
}

Changes

  • 0ca400461c52Revision changes
    • info

      added the optional property to the response with the status

    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status