Charge Points / Update

patch deprecatedhttps://{tenantUrl}/public-api/resources/charge-points/v1.0/{chargePoint}

Update a charge point

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

chargePoint

integer

required

Body Params

name

string

networkId

string | null

OCPP Identifier

networkProtocol

string

networkPassword

string | null

networkIp

string | null

required for ocpp 1.5 (SOAP)

networkPort

string | null

required for ocpp 1.5 (SOAP)

status

string

plugAndCharge

boolean

Enable this flag if you the CP is configured in plug and charge mode, it automatically starts a session when a car is plugged in, and the ID tag should not be authorized

locationId

integer | null

locationId is always a REQUIRED field for commercial public and commercial private charge points. It is NOT a required field only for personal charge points.

string

pin is always a REQUIRED field for personal charge points. It is NOT a required field for commercial public and commercial private charge points.

accessType

string

Defaults to public

desiredSecurityProfile

integer | null

0 to 2

The security profile that the backend will try to force the charge point to use for connecting to the backend. Description of the supported security profiles can be found in the security whitepaper available here - https://www.openchargealliance.org/protocols/ocpp-16/

ownerPartnerId

integer | null

ownerPartnerContractId

integer | null

partnerCorporateBillingAsDefault

boolean

For users who have corporate billing with the same Partner as the Partner assigned to the charge point, the default payment method on this charge point will be the respective corporate billing account of the Partner.

partnerAccessType

string

Applicable only to Commercial Private charge points. Further defines the access type and visibility of the charge point.

capabilities

array of strings

capabilities

managedByOperator

boolean

tags

array of strings

Tags can be used for filtering and grouping chargers by tag. When doing a PATCH input all tags that should be associated with the charge point. Omitting a tag would remove it from the charge point.

tags

evses

object

externalId

string | null

The field should have unique value

Responses

Response body

object

integer

required

chargingProfile

object | null

integer

min_charging_rate

number | null

schedule_periods

array of objects | null

schedule_periods

object

startPeriod

integer

limit

number

numberPhases

integer

schedule_start

string | null

charging_rate_unit

string

A W

stack_level

integer

charging_profile_kind

string

Absolute Recurring Relative

recurrency_kind

string | null

daily weekly

charging_complete_at

string | null

purpose

string

ChargePointMaxProfile TxDefaultProfile TxProfile

valid_to

string | null

valid_from

string | null

duration

integer | null

evses

array of objects

required

evses*

object

integer

required

externalId

string | null

chargingProfile

object | null

roaming

object

If the evse was received from a roaming CPO, this object will contain the details

connectors

array of objects

connectors

object

integer

status

string

active disabled

type

string

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

socket cable

networkId

string

required

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

physicalReference

string

The identifier that is presented to the user, so he can identify the EVSE at the location

currentType

string

ac dc

maxPower

number | null

in Wh

maxVoltage

string | null

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

status

string

active disabled out of order

midMeterCertificationEndYear

number | null

The mid meter certification end year.

tariffGroupId

integer | null

The id of the tariff group associated with the evse

allowsReservation

boolean

are reservations allowed on this EVSE

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

lastBootNotification

object | null

model

string

vendor

string

charge_box_serial_number

string | null

charge_point_serial_number

string | null

firmware_version

string | null

iccid

string | null

imsi

string | null

meter_serial_number

string | null

meter_type

string | null

reason

string | null

showToPublicWithNotice

boolean

Only available if the ChargePoint has private access

notice

string | null

The notice is only available if showToPublicWithNotice is set to "true"

currentSecurityProfile

integer

The security profile that is currenty being used by the charge point. Description of the supported security profiles can be found in the security whitepaper available here - https://www.openchargealliance.org/protocols/ocpp-16/

hardwareEnabledSecurityProfile

integer | null

The maximum security profile that the charge point hardware supports. Description of the supported security profiles can be found in the security whitepaper available here - https://www.openchargealliance.org/protocols/ocpp-16/

desiredSecurityProfileStatus

string

Whether the last requested desiredSecurityProfile was successfully applied to the charge point

applied pending rejected

roamingOperatorId

integer | null

When null the charge point is a local one. For roaming charge points, the ID of the roaming operator is provided

autoFaultRecovery

boolean

By enabling this, the charge point will attempt to automatically recover from the faulted state and resume normal operations.

externalId

string | null

The field should have unique value

displayTariffsAndCosts

boolean | null

lastUpdatedAt

date-time

ISO 8601 formatted date

createdAt

date-time

ISO 8601 formatted date

firstConnection

date-time | null

ISO 8601 formatted date

ownerUserId

integer | null

vendorErrorCode

string | null

This property is shown only when the hardwareStatus is faulted.

tags

array of strings

Tags can be used for filtering and grouping chargers by tag. When doing a PATCH input all tags that should be associated with the charge point. Omitting a tag would remove it from the charge point.

tags

name

string

networkId

string | null

OCPP Identifier

networkProtocol

string

required

ocpp 1.5 ocpp 1.6 ocpp 1.6 soap ocpp 2.0.1

networkPassword

string | null

networkIp

string | null

required for ocpp 1.5 (SOAP)

networkPort

string | null

required for ocpp 1.5 (SOAP)

status

string

active disabled out of order demo

plugAndCharge

boolean

Enable this flag if you the CP is configured in plug and charge mode, it automatically starts a session when a car is plugged in, and the ID tag should not be authorized

locationId

integer | null

locationId is always a REQUIRED field for commercial public and commercial private charge points. It is NOT a required field only for personal charge points.

string

pin is always a REQUIRED field for personal charge points. It is NOT a required field for commercial public and commercial private charge points.

accessType

string

required

Defaults to public

private public personal

desiredSecurityProfile

integer | null

0 to 2

ownerPartnerId

integer | null

ownerPartnerContractId

integer | null

partnerCorporateBillingAsDefault

boolean

partnerAccessType

string

Applicable only to Commercial Private charge points. Further defines the access type and visibility of the charge point.

privateViewPrivateUse privateViewPublicUse publicViewPrivateUse

capabilities

array of strings

capabilities

managedByOperator

boolean

networkStatus

string

required

Connection status of the charge point:

never connected - the charge point has not yet connected to the CPMS
available - connected to the CPMS
temporarily unavailable - disconnected a short while ago
long-term unavailable - disconnected, and some time has passed, so we dont expect the connection will be restores

never connected available temporarily unavailable long-term unavailable

hardwareStatus

string | null

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

available unavailable faulted

422

The payload you provided is invalid

Language

Credentials

Bearer

API Token

URL


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://example.com/public-api/resources/charge-points/v1.0/chargePoint \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

200Charge point updated successfully

401Access token is missing or invalid

403You do not have permission to perform the action

404The record is not found