EVSE / Create

post https://{tenantUrl}/public-api/resources/evses/v2.1

Create new EVSE

Body Params

chargePointId

integer

required

The ID of the charge point.

physicalReference

string

required

The identifier that is presented to the users, so they can identify the EVSE at the location.

currentType

string

required

label

string

The EVSE label will be exposed and visualized in the mobile application

networkId

string

required

The OCPP evse identifier (should be consecutive numbers starting from 1)

status

string

required

For roaming EVSEs the status can only be updated if the option for manual management of EVSEs is enabled for the roaming CPO.

midMeterCertificationEndYear

integer | null

The mid meter certification end year.

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

Manages whether reservations are allowed on this EVSE. Requires the Reservations to be activated for the system in order to enable for the EVSE.

powerOptions

object

externalId

string

Responses

Response body

object

data

object

chargePointId

integer

required

The ID of the charge point.

integer

required

physicalReference

string

required

The identifier that is presented to the users, so they can identify the EVSE at the location.

label

string

The EVSE label will be exposed and visualized in the mobile application

currentType

string

required

ac dc

networkId

string

required

The OCPP evse identifier (should be consecutive numbers starting from 1)

status

string

required

For roaming EVSEs the status can only be updated if the option for manual management of EVSEs is enabled for the roaming CPO.

enabled disabled out of order

midMeterCertificationEndYear

integer

The mid meter certification end year.

tariffGroupId

integer

allowsReservation

boolean

Manages whether reservations are allowed on this EVSE. Requires the Reservations to be activated for the system in order to enable for the EVSE.

powerOptions

object

externalId

string

roaming

object

hardwareStatus

string | null

required

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 vehicle 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 vehicle is connected to the evse and the evse is offering energy but the vehicle 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 sent 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).

occupied - If OCPP 2.0.1 is used, the EVSE hardware status is occupied when in session.

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 occupied

chargingProfile

object | null

connectors

array of objects

connectors

object

integer

required

type

string

required

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 gb-t-ac gb-t-dc

format

string

socket cable

status

string

enabled disabled

externalAppData

object | null

Used to hold any external application data related to the EVSE.

Has additional fields

createdAt

date-time

required

ISO 8601 formatted date

lastUpdatedAt

date-time

required

ISO 8601 formatted date

422

The payload you provided is invalid

Language

Credentials

Bearer

API Token

URL


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://example.com/public-api/resources/evses/v2.1 \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "currentType": "ac",
8
  "status": "enabled"
9
}
10
'

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

application/json

201EVSE created successfully

401Access token is missing or invalid

403You do not have permission to perform the action

404The record is not found