Charge Points / Update

patch https://{tenantUrl}/public-api/resources/charge-points/v2.0/{chargePoint}

Update a charge point

Path Params

chargePoint

integer

required

Query Params

include

array of strings

include

Body Params

name

string

length ≤ 255

type

string

public - a charge point visible on the map to everybody

private - by default hidden from the map and for private usage only - company and their employees for example. The visibility of the charge point could be managed in partner object, with the different options for accessType.

personal - the charge point could have a single owner only. The owner is set when the user claims the charger or with Actions / Change Owner.

string | null

Pin is always a REQUIRED field for personal charge points. It is NOT a required field for commercial public and commercial private charge points. This PIN is necessary when the charge point is claimed by the user, the latter should provide the PIN in the mobile app. Should contain only numbers.

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.

chargingZoneId

integer | null

electricityRateId

integer | null

If there is Electricity rate set to the Charge point the electricity cost for each charging session would be tracked. Dynamic electricity rates could not be selected, only ones created in the resource / electricity-rate.

subscription

object

An active subscription could be required for personal (home) charge points in order to use the charge point.

networkType

string

status

string

Shows the system status of the Charge Point.

enabled - the charge point is fully operative.
disabled - the charge point would not be shown on the map if it is a commercial public or commercial private with the relevant option for visibility nor could be claimed or found by ID if it is personal (home).
demo - acts as a simulator so different setups could be tested.
out of order - the charge point is visible and shared with users, but a charging session

managedByOperator

boolean

Defaults to true

The main purpose of this checkbox is to distinguish local charge points from roaming ones. The checkbox could be also used for charge points where the network connectivity is very poor and when disabled, the charge point would be still visible on the map and shared with Users.

externalId

string | null

network

object

capabilities

array of strings

remote_start_stop_capable - whether Remote start/stop is possible for the Charge Point

meter_values - whether the Charge Point should send meter updates to the system

stop_transaction_on_ev_disconnect - for ongoing sessions, when the cable is unplugged this should stop the session and if it is returned back a new session would be created.

disregard_the_heartbeats - only for OCPP 1.5 SOAP. Network status by default is updated based on the heartbeat messages. When enabled, the Charge Point would be always treated as available and its network status would not depend on heartbeat messages.

display_messages - charger has a display and it is enabled to display messages. This capability is enabled automatically when the charger reports the corresponding configuration key. When creating a charge point, the capability is ignored as it is automatically detected on boot.

capabilities

autoStartWithoutAuthorization

boolean

Defaults to false

When enabled the system would allow charging sessions initiated

locally by the charge point assuming it is setup to work in auto-start /

plug-and-charge mode. It would also automatically start a

session with a remote start command if one is not already started by the charging stations a

few seconds after a Preparing status is detected indicating that a vehicle is connected.

disableAutoStartEmulation

boolean

Defaults to false

The Auto-start option above does 2 things: (1) it allows charging

sessions started by the charge point assuming that it may be set up locally

to auto-start charging when a vehicle is connected and (2) if the charging

station doesnt start the session within a few seconds after the vehicles is

connected the system sends a remote start command - which is to emulate auto-start

charging. With this checkbox you can disable the emulation and rely

entirely on the charging station to auto-start the charging.

security

object

modelId

integer | null

The ID of the CP Model, if one is associated with the Charge Point. Can be set to null to remove the current CP Model associated with the Charge Point. Mind that on boot the charger reports the hardware model and it is automatically updated.

enableAutoFaultRecovery

boolean

Defaults to true

user

object

This is the owner of the charge point when of type personal. If the smart charging is enabled, the owner preferences would be returned.

partner

object

utilityId

integer | null

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

enabledRandomisedDelay

boolean

Applicable only for personal charge points. For public and private charge points will be omitted

noticeId

integer | null

If both noticeId and partner.notice object are provided in the request the noticeId will be used to complete the request NOT the partner.notice object!

usesRenewableEnergy

boolean

Defaults to false

When enabled, if no electricity rate is assigned to the charge point any roaming session will be marked as using renewable energy.
The actual energy mix can be specified in an electricity rate, which can then be assigned to the charge point. In that case the energy mix will be provided for roaming sessions.
This information can be gathered from the utility provider or third-party platforms that provide this information to the public.

integratedAt

date-time | null

ISO 8601 formatted date

manufacturedAt

date-time | null

ISO 8601 formatted date

Responses

Response body

object

data

object

integer

name

string

required

length ≤ 255

type

string

required

private public personal

string

length ≤ 4

locationId

integer

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.

chargingZoneId

integer | null

electricityRateId

integer

subscription

object

An active subscription could be required for personal (home) charge points in order to use the charge point.

networkType

string

cellular ethernet wlan

status

string

required

Shows the system status of the Charge Point.

enabled - the charge point is fully operative.
disabled - the charge point would not be shown on the map if it is a commercial public or commercial private with the relevant option for visibility nor could be claimed or found by ID if it is personal (home).

demo - acts as a simulator so different setups could be tested.

out of order - the charge point is visible and shared with users, but a charging session

enabled disabled out of order demo

managedByOperator

boolean

required

Defaults to true

externalId

string

network

object

required

capabilities

array of strings

capabilities

autoStartWithoutAuthorization

boolean

required

Defaults to false

disableAutoStartEmulation

boolean

required

Defaults to false

security

object

required

modelId

integer | null

enableAutoFaultRecovery

boolean

required

Defaults to true

user

object

This is the owner of the charge point when of type personal. If the smart charging is enabled, the owner preferences would be returned.

partner

object

utilityId

integer | null

createdAt

date-time

ISO 8601 formatted date

firstContactAt

date

ISO 8601 formatted date

roamingOperatorId

integer

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

chargingProfile

object | null

displayTariffAndCosts

boolean

The charge point has a display and messages could be shown to the user.

lastBootNotification

object | null

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

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

vendorErrorCode

string

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

sharingCode

string

enabledRandomisedDelay

boolean

Applicable only for personal charge points. For public and private charge points will be omitted

noticeId

integer | null

If both noticeId and partner.notice object are provided in the request the noticeId will be used to complete the request NOT the partner.notice object!

usesRenewableEnergy

boolean

Defaults to false

integratedAt

date-time | null

ISO 8601 formatted date

manufacturedAt

date-time | null

ISO 8601 formatted date

lastUpdatedAt

date-time

ISO 8601 formatted date

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/v2.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