AXaxle
4. Assets

Asset Tariff Update Event

Changed on

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

Request

  • Base URL
    https://api-sandbox.axle.energy
  • URL
    https://api-sandbox.axle.energy/entities/asset/{asset_id}/event/tariff-update
  • Auth
    OAuth 2
    Password
    Token URL: auth/token-form

Path parameters

asset_idstring uuid required

Request body

Example request

{
  "tariff": {
    "off_peak_times": "Mo-Su 00:30-05:30",
    "timezone": "Europe/London"
  }
}

Response

Tariff update event successfully processed

unknown required

Changes

  • b0b07b1dbf12Revision changes
    • breaking

      added to the // request property allOf list

    • breaking

      removed the enum value dual_rate of the request property //

    • breaking

      removed the enum value dynamic of the request property //

    • breaking

      removed the enum value single_rate of the request property //

    • breaking

      removed the enum value smart of the request property //

    • breaking

      removed the enum value unknown of the request property //

    • breaking

      the // request property type changed from string to no type