List standalone HEMS steering sessions for a wallbox

GET

api

partners

v2.0

org

{org_id}

users

{user_id}

wallboxes

{wallbox_id}

hems-sessions

List standalone HEMS steering sessions for a wallbox

curl --request GET \
  --url https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/wallboxes/{wallbox_id}/hems-sessions \
  --header 'Authorization: Bearer <token>'

{
  "total": 123,
  "items": [
    {
      "id": 123,
      "ocpp_transaction_id": 123,
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "final_hems_state": "<string>",
      "energy_from_solar_kwh": 123,
      "savings_eur": 123,
      "has_complete_price_coverage": true,
      "commands_sent": 123,
      "commands_applied": 123,
      "commands_ineffective": 123
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

org_id

string<uuid>

required

The organization ID

user_id

string<uuid>

required

The user ID

wallbox_id

string<uuid>

required

The wallbox ID

Query Parameters

from

string<date>

required

Inclusive lower bound day (UTC, YYYY-MM-DD)

string<date>

required

Inclusive upper bound day (UTC, YYYY-MM-DD)

limit

integer

default:50

Page size (max 200)

Required range: 1 <= x <= 200

offset

integer

default:0

Offset for pagination

Required range: x >= 0

Response

200 - application/json

total

integer

required

items

HEMSSessionItem · object[]

required

Show child attributes

Get the currently running standalone HEMS session for a wallboxReturns the open session wrapped as `{ "session": ... }` with its decision timeline and per-command steering verdicts. When none is running, returns 200 with `{ "session": null }` so clients can poll without exception handling.

List standalone HEMS steering sessions for a wallbox

curl --request GET \
  --url https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/wallboxes/{wallbox_id}/hems-sessions \
  --header 'Authorization: Bearer <token>'

{
  "total": 123,
  "items": [
    {
      "id": 123,
      "ocpp_transaction_id": 123,
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "final_hems_state": "<string>",
      "energy_from_solar_kwh": 123,
      "savings_eur": 123,
      "has_complete_price_coverage": true,
      "commands_sent": 123,
      "commands_applied": 123,
      "commands_ineffective": 123
    }
  ]
}