EVSE / Update

put deprecatedhttps://{tenantUrl}/public-api/resources/evses/v2.0/{evse}

Update a EVSE

Path Params

evse

integer

required

Body Params

connectors

array of objects | null

connectors

physicalReference

string

required

Unique identifier of the EVSE. QR code or EVSE ID for Roaming.

type

string

required

networkId

string

required

The identifier of the EVSE within the station. Protocol specific. For OCPP use consecutive numbers starting from 1

status

string

required

tariffGroupId

integer | null

The ID of the tariff group attached to the EVSE. If the EVSE is not roaming and tariffGroupId is not specified, the default (free) tariff will be assigned. For roaming EVSEs the Tariff Group can only be updated if the option for manual management of EVSEs is enabled for the roaming CPO.

allowsReservation

boolean

required

Indicates the evse capability of accepting reservations.

maxPowerKw

number | null

The max power displayed for the EVSE in the app. This value is NOT enforced, it is just to be displayed in the app.

maxVoltage

string

required

The maxVoltage of a CP can fluctuate. Hence, when creating a CP in Ampeco system the maxVoltage is given as a range. For OCPI purposes it maps as follows:

220-240 = 230
110-130 = 120
400 = 400
380 = 380

maxAmperage

number | null

phases

string | null

required

phaseRotation

string | null

midMeterCertificationEndYear

integer | null

The mid meter certification end year.

externalId

string | null

Responses

Response body

object

data

object

integer

chargePointId

integer

chargingProfile

object | null

roaming

object | null

connectors

array of objects | null

connectors

object

integer

type

string | null

type1 type2 type3 chademo ccs1 ccs2 catarc schuko nacs cee16 cee32 j1772 inductive nema-5-20 type-e-french type-g-british type-j-swiss avcon

format

string | null

socket cable

status

string | null

active disabled

physicalReference

string

required

Unique identifier of the EVSE. QR code or EVSE ID for Roaming.

type

string

required

ac dc

networkId

string

required

The identifier of the EVSE within the station. Protocol specific. For OCPP use consecutive numbers starting from 1

status

string

required

active disabled out of order

tariffGroupId

integer | null

allowsReservation

boolean

required

Indicates the evse capability of accepting reservations.

maxPowerKw

number | null

The max power displayed for the EVSE in the app. This value is NOT enforced, it is just to be displayed in the app.

maxVoltage

string

required

The maxVoltage of a CP can fluctuate. Hence, when creating a CP in Ampeco system the maxVoltage is given as a range. For OCPI purposes it maps as follows:

220-240 = 230
110-130 = 120
400 = 400
380 = 380

230 380 400 480 120 208 240 110-130 220-240

maxAmperage

number | null

phases

string | null

required

single_phase three_phase

phaseRotation

string | null

rst rts srt str trs tsr

midMeterCertificationEndYear

integer | null

The mid meter certification end year.

externalId

string | null

hardwareStatus

string | null

Status reported by the charge point's EVSE:

available - When a Connector becomes available for a new user (Operative)
preparing - When a Connector becomes no longer available for a new user but there is no ongoing Transaction (yet). Typically a Connector is in preparing state when a user presents a tag, inserts a cable or a vehicle occupies the parking bay (Operative)
charging - When the contactor of a Connector closes, allowing the vehicle to charge (Operative)
suspendedEVSE - When the EV is connected to the EVSE but the EVSE is not offering energy to the EV, e.g. due to a smart charging restriction, local supply power constraints. (Operative)
suspendedEV - When the EV is connected to the EVSE and the EVSE is offering energy but the EV is not taking any energy. For example the driver has unlocked the car, and the car has paused charging. (Operative)
finishing - When a Transaction has stopped at a Connector, but the Connector is not yet available for a new user, e.g. the cable has not been removed or the vehicle has not left the parking bay (Operative)
reserved - When a EVSE becomes reserved as a result of a Reserve Now command (Operative)
unavailable - When a EVSE becomes unavailable as the result of a Change Availability command or an event upon which the Charge Point transitions to unavailable at its discretion. Upon receipt of a Change Availability command, the status MAY change immediately or the change MAY be scheduled. When scheduled, the Status Notification shall be send when the availability change becomes effective (Inoperative)
faulted - When a Charge Point or connector has reported an error and is not available for energy delivery (Inoperative)

When hardware status is null, that means that the charge point has not connected yet or has not reported a hardware status for this evse in the past

available preparing charging suspendedEV suspendedEVSE finishing reserved unavailable faulted

422

The payload you provided is invalid

Language

Credentials

Bearer

API Token

URL


xxxxxxxxxx
13
1
curl --request PUT \
2
     --url https://example.com/public-api/resources/evses/v2.0/evse \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "type": "ac",
8
  "status": "active",
9
  "allowsReservation": true,
10
  "maxVoltage": "230",
11
  "phases": "single_phase"
12
}
13
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200EVSE updated successfully

401Access token is missing or invalid

403You do not have permission to perform the action

404The record is not found