APIs/Energy API
APIs/Energy API

Charging connection status

Get charging connection status

Endpoint used to get vehicle's latest charging connection status.

get

https://api.volvocars.com/energy/v1/vehicles/{vin}/recharge-status/charging-connection-status

Scopes

  • openid

  • energy:charging_connection_status

Headers

KeyDescription
Key
accept
Description
The mediatype of what should be returned. The valid values are: application/vnd.volvocars.api.energy.vehicledata.v1+json
Key
authorization
Description
The access token issued by Volvo ID identity system.
Key
vcc-api-key
Description
Your application’s VCC API Key.
All these header values are mandatory. They must exist in every request.

Response body

The response’s data node lists the vehicle’s latest charging connection status.

FieldDescription
Field
chargingConnectionStatus.value
Description
The latest retrieved charging connection status. Possible values: CONNECTION_STATUS_CONNECTED_AC, CONNECTION_STATUS_CONNECTED_DC, CONNECTION_STATUS_DISCONNECTED, CONNECTION_STATUS_UNSPECIFIED.
Field
chargingConnectionStatus.timestamp
Description
Timestamp based on system UTC clock when the value has been last retrieved from the vehicle.

Examples

curl -v -X GET 'https://api.volvocars.com/energy/v1/vehicles/{vin}/recharge-status/charging-connection-status' \
-H 'accept: application/vnd.volvocars.api.energy.vehicledata.v1+json' \
-H 'authorization: Bearer <your-access-token>' \
-H 'vcc-api-key: <your-vcc-api-key>'

Charging connection status/Get charging connection status