Plug-out event - axle energy

POST

/

entities

/

asset

/

{asset_id}

/

event

/

plug-out

Asset Plug Out Event

curl --request POST \
  --url https://api-sandbox.axle.energy/entities/asset/{asset_id}/event/plug-out \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "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 plug-out events.

This is an empty request model to allow for future updates.

Response

Plug-out event successfully processed

Send readingsSend asset readings data to Axle using the generic readings format. This endpoint accepts compressed data using gzip encoding. Returns statuses of the processed readings, indicating whether each reading was accepted or rejected. **Direction convention:** for readings that can be either positive or negative (e.g. `boundary_import_kw`, `battery_inverter_import_kw`), a positive value denotes *import* (power flowing in from the grid, or into the battery) and a negative value denotes *export* (power flowing out to the grid, or out of the battery). All other reading types are unidirectional; the required sign for each `label` is documented in the `ReadingDataPointLabel` schema below.

⌘I

Asset Plug Out Event

curl --request POST \
  --url https://api-sandbox.axle.energy/entities/asset/{asset_id}/event/plug-out \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

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