AXaxle
4. Assets

Asset Event

Changed on

Send notification of an event happening on an asset.

This endpoint allows reporting various events related to an asset, such as:

  • Plug-in/plug-out events
  • Updates to charging intent
  • Charge now events

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.

post/entities/asset/{asset_id}/event

Request

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

Path parameters

asset_idstring uuid required

Request body

event_type'plug_in' | 'plug_out' | 'intent_update' | 'charge_now' | 'charge_now_deleted' required
end_atstring date-time

End time for the charge. This should only be included for "charge_now" events

Example request

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

Response

Event successfully processed

unknown required

Changes

  • b0b07b1dbf12Revision changes
    • breaking

      added to the request property allOf list

    • breaking

      added to the // request property allOf list

    • breaking

      removed the enum value charge_now of the request property

    • breaking

      removed the enum value charge_now_deleted of the request property

    • 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 intent_update of the request property

    • breaking

      removed the enum value plug_in of the request property

    • breaking

      removed the enum value plug_out 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

    • breaking

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

    • warning

      removed the request property //