API Reference

Send tariff

Send notification of a tariff update for an asset.

The off_peak_times field must comply with the OSM opening hours standard (https://wiki.openstreetmap.org/wiki/Key:opening_hours) and have a valid timezone, or a 400 error will be returned.

The same off-peak times apply every day, day-of-week selectors are not supported. Use , to separate multiple time ranges. Common examples:

Same-day off-peak (e.g. midnight to 7am): 00:00-07:00
Overnight off-peak (e.g. 11:30pm to 5:30am): 00:00-05:30, 23:30-24:00

POST

entities

asset

{asset_id}

event

tariff-update

Asset Tariff Update Event

curl --request POST \
  --url https://api-sandbox.axle.energy/entities/asset/{asset_id}/event/tariff-update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tariff": {
    "off_peak_times": "<string>",
    "timezone": "<string>"
  }
}
'

{
  "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

Request model for a user's tariff update.

tariff

Tariff · object

required

Updated tariff information.

Show child attributes

Response

Tariff update event successfully processed

Plug-in eventSend notification of a car being plugged in. Tariff, vehicle and intent information may be optionally provided. If a tariff is included, it 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 Tariff Update Event

curl --request POST \
  --url https://api-sandbox.axle.energy/entities/asset/{asset_id}/event/tariff-update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tariff": {
    "off_peak_times": "<string>",
    "timezone": "<string>"
  }
}
'

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

Documentation Index

Authorizations

Path Parameters

Body

Response