Overview

There you will find a brief description of new features, breaking changes, and other updates made to version 2 of the Energy API.

New features

The Partner Energy API version 2 with new endpoints will completely replace version 1. The details about the changes are listed below.

Please update your server-side code to use the new features available on version 2 of this API.

New endpoints

Capabilities

Added a new endpoint to get the Energy API related capabilities of the vehicle.

Energy State

Added a new endpoint to get the vehicles energy state related data points.

Breaking changes

General

Common response model - This wrapper is removed. Endpoints return unwrapped results. The v1 fields status (HTTP status) and operationId (VCC-API-OperationId header) are available in the HTTP response.

Content type headers - Content type header is now always application/json. This is done to simplify API consumption. Version is now always defined in the API URL path.

Accept headers - Accept header is now always application/json. This is done to simplify API consumption. Version is now always defined in the API URL path.

Deprecated endpoints

These endpoints will be removed in the near future

Replaced by the new energy state endpoint available at vehicles/{vin}/state:

• vehicles/{vin}/recharge-status, the endpoint for getting the recharge-status of the vehicle.
• vehicles/{vin}/recharge-status/battery-charge-level, the endpoint for getting the charge level of the battery.
• vehicles/{vin}/recharge-status/electric-range, the endpoint for getting the estimated electric range.
• vehicles/{vin}/recharge-status/charging-connection-status, the endpoint for getting the charging connection status.
• vehicles/{vin}/recharge-status/charging-system-status, the endpoint for getting the charging system status.
• vehicles/{vin}/recharge-status/estimated-charging-time, the endpoint for getting the estimated battery charging time.
• vehicles/{vin}/recharge-status/charging-current-limit, the endpoint for getting the charging current limit.
• vehicles/{vin}/recharge-status/target-battery-charge-level, the endpoint for getting the targeted battery charge level.

Replaced by the Subscription API (not part of Energy API):

• vehicles/{vin}/subscriptions, the endpoint for getting, adding and deleting event subscriptions.

Replaced by the new charging locations endpoint available at vehicles/{vin}/charging-locations/{locationId}:

• vehicles/{vin}/recharge-status/charging-settings, the endpoint for getting the charging settings.

Replaced by the new charging schedule endpoint available at vehicles/{vin}/charging-locations/{locationId}/charging-schedule:

• vehicles/{vin}/charging-locations/{id}/charging-timer, the endpoint for getting, setting and deleting charging timers.