Charge Points / Read / Status

get https://{tenantUrl}/public-api/resources/charge-points/v1.0/{chargePoint}/status

Get a charge point's status

Responses

Response body

object

data

object

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

evses

array of objects

evses

object

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

integer

lastUpdatedAt

date-time

ISO 8601 formatted date

Language

Credentials

Bearer

API Token

URL


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

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

application/json

200Success

401Access token is missing or invalid

403You do not have permission to perform the action

404The record is not found