APIs/Energy APIVersion 1
APIs/Energy APIVersion 1

Charging connection status

Get charging connection status

Provides the latest retrieved charging connection status for a specific vehicle. It indicates whether the vehicle is currently connected to a charging station and what type of charger is being used (AC or DC). The charging connection status can have several possible values:

  • CONNECTION_STATUS_CONNECTED_AC - Indicating that the vehicle is connected to an AC charger.
  • CONNECTION_STATUS_CONNECTED_DC - Indicating that the vehicle is connected to a DC charger.
  • CONNECTION_STATUS_DISCONNECTED - Indicating that the vehicle is not currently connected to a charger.
  • CONNECTION_STATUS_FAULT - Indicating that there is a fault with the charging connection.
  • CONNECTION_STATUS_UNSPECIFIED - Indicating that the charging connection status is not currently known.

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_FAULT, CONNECTION_STATUS_UNSPECIFIED.

Field

chargingConnectionStatus.timestamp

Description

Timestamp in ISO-8601 format 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-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>'

/