Get schedules for a heat pump - Podero Documentation

GET

api

partners

v2.0

org

{org_id}

users

{user_id}

heat-pumps

{heat_pump_id}

schedules

Get schedules for a heat pump

curl --request GET \
  --url https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps/{heat_pump_id}/schedules \
  --header 'Authorization: Bearer <token>'

{
  "metadata": {
    "requested_at": "<string>",
    "query": {
      "org_id": "<string>",
      "user_id": "<string>",
      "heat_pump_id": "<string>",
      "from_datetime": "<string>",
      "to_datetime": "<string>"
    },
    "error": ""
  },
  "data": [
    {
      "time": "<string>",
      "state": "<string>"
    }
  ]
}

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 of the user's organization

user_id

string<uuid>

required

The user ID of the user whom the heat pump belongs to

heat_pump_id

string<uuid>

required

The ID of the specified heat pump

Query Parameters

from_datetime

string<date-time>

required

The start of the time range for the data

to_datetime

string<date-time>

required

The end of the time range for the data

Response

200 - application/json

metadata

HeatPumpSchedulesMetadata · object

required

Show child attributes

data

HeatPumpScheduleOutput · object[]

required

Show child attributes

Get savings data for a specified heat pumpRetrieve time-bucketed savings data for a specified heat pump within a given date range.

Get schedules for a heat pump

curl --request GET \
  --url https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps/{heat_pump_id}/schedules \
  --header 'Authorization: Bearer <token>'

{
  "metadata": {
    "requested_at": "<string>",
    "query": {
      "org_id": "<string>",
      "user_id": "<string>",
      "heat_pump_id": "<string>",
      "from_datetime": "<string>",
      "to_datetime": "<string>"
    },
    "error": ""
  },
  "data": [
    {
      "time": "<string>",
      "state": "<string>"
    }
  ]
}