APIs/Energy APIVersion 1
APIs/Energy APIVersion 1

Charging system status

Get charging system status

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

get

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

Scopes

  • openid

  • energy:charging_system_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 system status.

FieldDescription

Field

chargingSystemStatus.value

Description

The latest retrieved charging system status. Possible values: CHARGING_SYSTEM_CHARGING, CHARGING_SYSTEM_IDLE, CHARGING_SYSTEM_DONE, CHARGING_SYSTEM_FAULT, CHARGING_SYSTEM_SCHEDULED, CHARGING_SYSTEM_UNSPECIFIED.

Field

chargingSystemStatus.timestamp

Description

Timestamp based on system UTC clock when the value has been last retrieved from the vehicle.

Examples

curl -X GET 'https://api.volvocars.com/energy/v1/vehicles/{vin}/recharge-status/charging-system-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 system status/Get charging system status