Send intent update event

POST

entities

asset

{asset_id}

event

intent

Asset Intent Update Event

curl --request POST \
  --url https://api-sandbox.axle.energy/entities/asset/{asset_id}/event/intent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "intent": {
    "energy_required_kwh": 123,
    "ready_by": "2023-11-07T05:31:56Z",
    "energy_estimated": true,
    "may_charge_peak": false,
    "charging_mode": "maximise_charging_time"
  }
}
'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

asset_id

string<uuid>

required

Body

application/json

This event should be triggered when the end user updates their charging preferences.

intent

Intent · object

required

Intent to charge the vehicle.

Show child attributes

intent.energy_required_kwh

number

required

intent.ready_by

string<date-time>

required

intent.energy_estimated

boolean

False if energy_required_kwh is derived from target %SOC set on vehicle (e.g. via Enode), True if the energy_required_kwh is purely a user input

intent.may_charge_peak

boolean

default:false

If True, the vehicle may be charged in peak periods but only if all off-peak periods are used up and the energy requirement is not met.

intent.charging_mode

enum<string>

default:maximise_charging_time

Charging strategy: maximise_charging_time (charge all available periods) or minimise_charging_time (charge only up to the user's stated intent in kWh)

Available options:

maximise_charging_time,

minimise_charging_time

Response

Intent event successfully processed

Send tariff update eventSend notification of a tariff update for an asset. The tariff must comply with the OSM opening hours standard (https://wiki.openstreetmap.org/wiki/Key:opening_hours) for off-peak times and have a valid timezone, or a 400 error will be returned.

⌘I

Asset Intent Update Event

curl --request POST \
  --url https://api-sandbox.axle.energy/entities/asset/{asset_id}/event/intent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "intent": {
    "energy_required_kwh": 123,
    "ready_by": "2023-11-07T05:31:56Z",
    "energy_estimated": true,
    "may_charge_peak": false,
    "charging_mode": "maximise_charging_time"
  }
}
'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

API Documentation

Authorizations

Path Parameters

Body

Response