Charge Points Charging Rules

Retrieve the list of charging rules for a charge point

GET

https://partner-api.monta.com

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

Required scope: charge-points:read
Organization authorization: supported

Retrieve the list of charging rules for a charge point › path Parameters

chargePointId

integer · int64 · required

Retrieve the list of charging rules for a charge point › query Parameters

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

number of items per page (between 1 and 100, default 10)

Default: 10

Retrieve the list of charging rules for a charge point › Responses

List of charging rules for the charge point

OffsetBasedResponse_12

ChargingRuleDto[] · required

MontaPage.Meta · required

GET/api/v1/charge-points/{chargePointId}/charging-rules

curl https://partner-api.monta.com/api/v1/charge-points/:chargePointId/charging-rules \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 1,
      "name": "Smart charging rule",
      "type": "smart_charge",
      "isActive": true,
      "isSponsored": true,
      "creatorUserId": 123,
      "vehicleId": 123,
      "supportedChargingRuleTypes": "[]",
      "settings": {
        "start": "22:00",
        "beReadyAt": "06:00",
        "delayedStart": false,
        "defaultMaxBatteryPercentage": 80
      },
      "chargePointId": 123
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

Create a charging rule for a charge point

POST

https://partner-api.monta.com

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

Required scope: charge-points:write
Organization authorization: supported

Create a charging rule for a charge point › path Parameters

chargePointId

integer · int64 · required

Create a charging rule for a charge point › Request Body

CreateChargingRule

name

string · required

Name of the charging rule

Example: Smart charging rule

type

string · enum · required

The type of the charging rule

Enum values:

smart_charge

scheduled

instant

Example: smart_charge

isActive

boolean · required

Indicates if this rule is active

Example: true

isSponsored

boolean · required

Indicates if the charge is sponsored

Example: true

creatorUserId

integer · int64 · required

User ID of the rule creator that you ware impersonating

Example: 123

object · required

The settings of the charging rule, depending on the type of the rule

vehicleId

integer | null · int64

Vehicle id of the vehicle this rule applies to

Example: 123

Create a charging rule for a charge point › Responses

Charging rule for charge point created

ChargingRuleDto

name

string · required

Name of the charging rule

Example: Smart charging rule

type

string · enum · required

The type of the charging rule

Enum values:

smart_charge

scheduled

instant

Example: smart_charge

isActive

boolean · required

Indicates if this rule is active

Example: true

isSponsored

boolean · required

Indicates if the charge is sponsored

Example: true

creatorUserId

integer · int64 · required

User that created this rule

Example: 123

supportedChargingRuleTypes

ChargingRuleType[] · required

The type of charging rules supported by this charge point

Enum values:

smart_charge

scheduled

instant

Default: []

object · required

The settings of the charging rule, depending on the type of the rule

id

integer · int64

Id of this charging rule

Example: 1

vehicleId

integer | null · int64

Vehicle id of the vehicle this rule applies to

Example: 123

chargePointId

integer | null · int64

Id of the charge point this rule belongs to

Example: 123

POST/api/v1/charge-points/{chargePointId}/charging-rules

curl https://partner-api.monta.com/api/v1/charge-points/:chargePointId/charging-rules \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Smart charging rule",
  "type": "smart_charge",
  "isActive": true,
  "isSponsored": true,
  "creatorUserId": 123,
  "vehicleId": 123,
  "settings": {
    "start": "22:00",
    "beReadyAt": "06:00",
    "delayedStart": false,
    "defaultMaxBatteryPercentage": 80
  }
}'

Example Request Body

{
  "name": "Smart charging rule",
  "type": "smart_charge",
  "isActive": true,
  "isSponsored": true,
  "creatorUserId": 123,
  "vehicleId": 123,
  "settings": {
    "start": "22:00",
    "beReadyAt": "06:00",
    "delayedStart": false,
    "defaultMaxBatteryPercentage": 80
  }
}

json

Example Responses

{
  "id": 1,
  "name": "Smart charging rule",
  "type": "smart_charge",
  "isActive": true,
  "isSponsored": true,
  "creatorUserId": 123,
  "vehicleId": 123,
  "supportedChargingRuleTypes": "[]",
  "settings": {
    "start": "22:00",
    "beReadyAt": "06:00",
    "delayedStart": false,
    "defaultMaxBatteryPercentage": 80
  },
  "chargePointId": 123
}

json

application/json

Retrieve a single charge point charging rule

GET

https://partner-api.monta.com

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

Required scope: charge-points:read
Organization authorization: supported

Retrieve a single charge point charging rule › path Parameters

chargePointId

integer · int64 · required

chargingRuleId

integer · int64 · required

Retrieve a single charge point charging rule › Responses

Charge point charging rule with provided id

ChargingRuleDto

name

string · required

Name of the charging rule

Example: Smart charging rule

type

string · enum · required

The type of the charging rule

Enum values:

smart_charge

scheduled

instant

Example: smart_charge

isActive

boolean · required

Indicates if this rule is active

Example: true

isSponsored

boolean · required

Indicates if the charge is sponsored

Example: true

creatorUserId

integer · int64 · required

User that created this rule

Example: 123

supportedChargingRuleTypes

ChargingRuleType[] · required

The type of charging rules supported by this charge point

Enum values:

smart_charge

scheduled

instant

Default: []

object · required

The settings of the charging rule, depending on the type of the rule

id

integer · int64

Id of this charging rule

Example: 1

vehicleId

integer | null · int64

Vehicle id of the vehicle this rule applies to

Example: 123

chargePointId

integer | null · int64

Id of the charge point this rule belongs to

Example: 123

Update a charging rule for a charge point

PUT

https://partner-api.monta.com

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

Required scope: charge-points:write
Organization authorization: supported

Update a charging rule for a charge point › path Parameters

chargePointId

integer · int64 · required

chargingRuleId

integer · int64 · required

Update a charging rule for a charge point › Request Body

UpdateChargingRule

name

string · required

Name of the charging rule

Example: Smart charging rule

type

string · enum · required

The type of the charging rule

Enum values:

smart_charge

scheduled

instant

Example: smart_charge

isActive

boolean · required

Indicates if this rule is active

Example: true

isSponsored

boolean · required

Indicates if the charge is sponsored

Example: true

object · required

The settings of the charging rule, depending on the type of the rule

vehicleId

integer | null · int64

Vehicle id of the vehicle this rule applies to

Example: 123

Update a charging rule for a charge point › Responses

Charging rule for charge point updated

ChargingRuleDto

name

string · required

Name of the charging rule

Example: Smart charging rule

type

string · enum · required

The type of the charging rule

Enum values:

smart_charge

scheduled

instant

Example: smart_charge

isActive

boolean · required

Indicates if this rule is active

Example: true

isSponsored

boolean · required

Indicates if the charge is sponsored

Example: true

creatorUserId

integer · int64 · required

User that created this rule

Example: 123

supportedChargingRuleTypes

ChargingRuleType[] · required

The type of charging rules supported by this charge point

Enum values:

smart_charge

scheduled

instant

Default: []

object · required

The settings of the charging rule, depending on the type of the rule

id

integer · int64

Id of this charging rule

Example: 1

vehicleId

integer | null · int64

Vehicle id of the vehicle this rule applies to

Example: 123

chargePointId

integer | null · int64

Id of the charge point this rule belongs to

Example: 123

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

curl https://partner-api.monta.com/api/v1/charge-points/:chargePointId/charging-rules/:chargingRuleId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Smart charging rule",
  "type": "smart_charge",
  "isActive": true,
  "isSponsored": true,
  "vehicleId": 123,
  "settings": {
    "start": "22:00",
    "beReadyAt": "06:00",
    "delayedStart": false,
    "defaultMaxBatteryPercentage": 80
  }
}'

Example Request Body

{
  "name": "Smart charging rule",
  "type": "smart_charge",
  "isActive": true,
  "isSponsored": true,
  "vehicleId": 123,
  "settings": {
    "start": "22:00",
    "beReadyAt": "06:00",
    "delayedStart": false,
    "defaultMaxBatteryPercentage": 80
  }
}

json

Example Responses

{
  "id": 1,
  "name": "Smart charging rule",
  "type": "smart_charge",
  "isActive": true,
  "isSponsored": true,
  "creatorUserId": 123,
  "vehicleId": 123,
  "supportedChargingRuleTypes": "[]",
  "settings": {
    "start": "22:00",
    "beReadyAt": "06:00",
    "delayedStart": false,
    "defaultMaxBatteryPercentage": 80
  },
  "chargePointId": 123
}

json

application/json

Delete a charging rule for a charge point

DELETE

https://partner-api.monta.com

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

Required scope: charge-points:write
Organization authorization: supported

Delete a charging rule for a charge point › path Parameters

chargePointId

integer · int64 · required

chargingRuleId

integer · int64 · required

Delete a charging rule for a charge point › Responses

Charging rule for charge point deleted

No data returned

Charge Points Charge Points Sensors