Enode Developers

Changelog: Versions

RSS

Keep track of updates and new API versions. More on versioning here.

  • Version 2023-04-15

    Released

    A new version of the Vehicle Smart Charging Plan API has been released, which adds new failure conditions.

    EndpointChange description
    GET /vehicles/{vehicleId}/smart-charging-plans/{smartChargingPlanId}CHARGE_INTERRUPTED and FINISHED_EARLY have been added to the failureCondition enum. Review your code to ensure that it can handle these new failure conditions. This change should not affect any existing functionality. CHARGE_INTERRUPTED indicates that the charging process was interrupted before completion, while FINISHED_EARLY indicates that the charging process was completed more than 90 minutes earlier than planned.

    Pass 2023-04-15 as your version header to use this new version.

  • Version 2023-04-01

    Released

    A new version with breaking changes to smart charging. This version simplifies considerations further.

    EndpointChange description
    GET /vehicles/{vehicleId}/smart-charging-statusisSmartChargeCapable, singleUser, needsSignificantCharge, wontStopExistingChargingSession, hasChargeAboveThreshold and likelyToGenerateSavings considerations have been removed from the consideration object
    GET /vehicles/{vehicleId}/smart-charging-statusConsideration recentlyAtChargingLocation has been renamed to atChargingLocation in the Vehicle Smart Charging StatusAPI API
    GET /vehicles/{vehicleId}/smart-charging-statusA new state, FULLY_CHARGED, has been added to the state enum. FULLY_CHARGED, will replace CONSIDERING when the vehicle does not need to be charged. This can be due to the vehicle having reached its charging limit or the battery being close to 100% charged. The vehicle will transition back into CONSIDERING once we detect that the vehicle has been used and needs to be charged.
    PUT /vehicles/{vehicleId}/smart-charging-policyThe logic for checking if the vehicle is capable of smart charging and if the user is a single user has been moved to the Update Vehicle Smart Charging PolicyAPI API. If the vehicle is not capable of smart charging or the user is not a single user, smart charging will not be turned on, and a 400 Bad Request will be returned.

    Pass 2023-04-01 as your version header to use this new version.

  • Version 2023-03-01

    Released

    The first version with breaking changes. This API version removes deprecated functionality and fields that have accumulated before Enode launched versioning.

    EndpointChange description
    POST /chargers/{chargerId}/charging, POST /vehicles/{vehicleId}/charging and /schedulesThe fields chargeableId, chargeableType, entityId, and entityType have been replaced with targetId and targetType
    /schedules/{scheduleId} and /scheduleschargeableType and entityType have been replaced with targetId.
    /vehicles/{vehicleId}/external-start and /vehicles/{vehicleId}/external-startThe External Start APIs for VehiclesAPI and ChargersAPI have been renamed to Smart override, which better reflects their intended use.
    POST /hvacs/{hvacId}/temperatureThe Set Temperature endpoint for HVACs has been replaced by the Set Permanent HoldAPI and Follow ScheduleAPI endpoints. The latter offer increased control over the underlying hardware, like the ability to change the thermostat's mode.
    /hvacs/{hvacId}Responses no longer contain targetTemperature
    GET /statistics/chargingThe vehicleId request body parameter to Get Charging StatisticsAPI has been replaced with id and type in order to support different types of hardware.
    /webhooksThe user:charge-action:updated webhook event has been renamed to user:vendor-action:updated.
    GET /vehicles and GET /vehicles/{vehicleId}The chargeState.isChargingReasons response field on the Vehicle APIAPI has been removed.
    GET /vehicles and GET /vehicles/{vehicleId}The information.id response field on the Vehicle APIAPI has been removed. Use information.vin instead.

    Pass 2023-03-01 as your version header to use this new version.

  • Version 2023-05-01

    Released

    Temperature Schedules are now supporting changing device modes. This allows access to the Permanent Hold and Follow Schedule endpoints through temperature schedules.

    EndpointChange description
    /schedules/{scheduleId} and /scheduleschargeableId and entityId have been replaced with targetId.
    /schedules/{scheduleId} and /scheduleschargeableType and entityType have been replaced with targetId.
    /schedules/{scheduleId} and /schedulesTemperature schedule: defaultTarget is replaced with defaultTargetState. Inside the rules array, both target and targetTemperature have been replaced with targetState.
    PUT /schedules/{scheduleId}Temperature Schedule: The object schema for the target state has been changed. The API now expects an object with at least a holdType, and possibly mode, coolSetpoint, and heatSetpoint. The holdType determines the kind of action sent to the device. Check out the Using Schedules guide for examples of valid objects.
    GET /schedules/{scheduleId}/statusThe externalStart object has been renamed to smartOverride.

    Pass 2023-05-01 as your version header to use this new version.