1. Heat
FoxCloud OpenAPI
Full API Reference
  • Vpp Flow
  • Full API Reference
  • Power Station
    • Get power station list
      POST
    • Get power station detail
      GET
    • Create power station
      POST
    • Delete power station
      POST
    • Edit power station
      POST
  • VPP
    • authorization code mode offboard by sn
      POST
    • client mode offboard
      POST
    • client mode onboard
      POST
  • Inverter-V1
    • Get device setting capabilities
      POST
    • Read device settings
      POST
    • Write device settings
      POST
    • Get device detail
      GET
    • Get device real-time data
      POST
  • Inverter
    • Get device list
      POST
    • Get device detail (Deprecated)
      GET
    • Get available variables
      GET
    • Get error code information
      GET
    • Get device real-time data (Deprecated)
      POST
    • Get device history data
      POST
    • Get device production report
      POST
    • Get device power generation
      GET
    • Get the minimum soc settings for the battery of device
      GET
    • Set the minmum soc for the battery of the device
      POST
    • Get the setting of battery charging time
      GET
    • Set the battery charging time
      POST
    • Get the device settings item
      POST
    • Set the device settings item
      POST
    • Get the device time
      POST
    • Set the device time
      POST
    • Get the device peakshaving settings
      POST
    • Set the device peakshaving settings
      POST
    • Get the Meter Reader
      POST
    • Set the Meter Reader
      POST
    • Get battery heating Parameter
      POST
    • Set battery heating Parameter
      POST
    • Get display sleep Paeameter
      POST
    • Set display sleep Paeameter
      POST
    • Get the device third party PV Integration status
      GET
    • Get Device Fault History
      POST
    • Get device PV power generation
      GET
  • Scheduler-V3
    • Get the time segment information
    • Set the time segment information
    • Batch set the time segment information
  • Scheduler-V2
    • Get the time segment information
    • Set the time segment information
  • Scheduler-V1
    • Get the main switch status
    • Set the main switch status
    • Get the time segment information
    • Set the time segment information
  • Scheduler (Deprecated)
    • Get the main switch status (Deprecated)
    • Get the time segment information (Deprecated)
    • Set the main switch status (Deprecated)
    • Set the time segment information (Deprecated)
  • Data Logger
    • Get Data Logger list
    • Get Data Logger Details
    • Get Data Logger Signal
    • Get Data Logger Wifi Info
    • Get Data Logger Lan Info
  • EMS
    • Get Ems list
    • Get Ems real-time data
    • Get Ems history data
    • Get Ems System Setting
    • Set Ems System Setting
    • Get Ems Rate Setting
    • Set Ems Rate Setting
    • Set Ems Ac Output Control Setting
    • Get Ems Ac Output Control Setting
    • Set Ems Power Limit Control Setting
    • Get Ems Power Limit Control Setting
    • Set Ems More Setting
    • Get Ems More Setting
    • Set Ems Gen Setting
    • Get Ems Gen Setting
  • Meter
    • Get meter list
    • Get the device settings item
    • Set the device settings item
  • Heat
    • genericControlsGet
      GET
    • genericControlsSet
      POST
    • heatingControlsGet
      GET
    • heatingControlsSet
      POST
    • heatingCircuitsControlsGet
      GET
    • heatingCircuitsControlsSet
      POST
    • dhwControlsGet
      GET
    • dhwControlsSet
      POST
    • heatAssetList-OAuth flow unsupported
      POST
    • changeKafkaPushStatus-OAuth flow unsupported
      POST
  • Schemas
    • CapabilityRequest
    • batteryList
    • HeatAssetListParam
    • CapabilityResponse
    • Result
    • CapabilityResult
    • CapabilityGroup
    • WeComLoginRequest
    • CapabilityField
    • ResponseInfo
    • ValueRange
    • Holiday
    • SettingGetRequest
    • DailyTimer
    • SettingGetResponse
    • GenericControlsData
    • SettingGetResult
    • GenericControlsParam
    • SettingSetRequest
    • WeekTimerItem
    • SettingSetResponse
    • HeatingControlsData
    • HeatingControlsParam
    • CircuitActivation
    • CircuitType
    • HeatingCircuitsControlsParam
    • DhwControlsData
    • DhwControlsParam
    • HolidayAway
    • HolidayHome
    • HeatKafkaPushStatusParam
    • TimerItem
    • DailyTimerTimerItem
    • DhwTimerItem
    • DailyTimerDhwTimerItem
    • TimerItem
    • DailyTimer
    • WeeklyTimer
    • DailyTimerTimerItem
    • BivalencePoint
    • DhwTimerItem
    • AuxiliaryHeaterSettings
    • DailyTimerDhwTimerItem
    • WeeklyTimerWeekTimerItem
    • BaseWeekTimerItem
    • WeeklyTimerBaseWeekTimerItem
    • CureSetting
    • HeatingCurves
    • HeatingCircuitsControlsData
    • TimerItem
    • DailyTimer
    • BivalencePoint
    • AuxiliaryHeaterSettings
  1. Heat

heatingCircuitsControlsSet

POST
/op/v0/heat/heatingCircuitsControls

Request

Header Params

Body Params application/json

Example
{
    "moduleSn": "string",
    "data": {
        "circuitActivation": {
            "zone1Support": true,
            "zone2Support": true,
            "zone3Support": true
        },
        "circuitType": {
            "zone1Enable": true,
            "zone2Enable": true,
            "zone3Enable": true
        },
        "zone1": {
            "enable": true,
            "temperatureLevel": 1,
            "temperatureMode": 1,
            "heatingCureOffsetValue": 0,
            "highComfort": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "highWarm": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "highEconomic": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "mediumComfort": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "mediumWarm": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "mediumEconomic": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "lowComfort": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "lowWarm": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "lowEconomic": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "cooling": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            }
        },
        "zone2": {
            "enable": true,
            "temperatureLevel": 1,
            "temperatureMode": 1,
            "heatingCureOffsetValue": 0,
            "highComfort": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "highWarm": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "highEconomic": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "mediumComfort": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "mediumWarm": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "mediumEconomic": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "lowComfort": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "lowWarm": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "lowEconomic": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "cooling": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            }
        },
        "zone3": {
            "enable": true,
            "temperatureLevel": 1,
            "temperatureMode": 1,
            "heatingCureOffsetValue": 0,
            "highComfort": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "highWarm": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "highEconomic": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "mediumComfort": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "mediumWarm": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "mediumEconomic": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "lowComfort": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "lowWarm": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "lowEconomic": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "cooling": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            }
        }
    }
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/op/v0/heat/heatingCircuitsControls' \
--header 'token;' \
--header 'signature;' \
--header 'timestamp;' \
--header 'lang: en' \
--header 'Content-Type: application/json' \
--data '{
    "moduleSn": "string",
    "data": {
        "circuitActivation": {
            "zone1Support": true,
            "zone2Support": true,
            "zone3Support": true
        },
        "circuitType": {
            "zone1Enable": true,
            "zone2Enable": true,
            "zone3Enable": true
        },
        "zone1": {
            "enable": true,
            "temperatureLevel": 1,
            "temperatureMode": 1,
            "heatingCureOffsetValue": 0,
            "highComfort": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "highWarm": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "highEconomic": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "mediumComfort": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "mediumWarm": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "mediumEconomic": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "lowComfort": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "lowWarm": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "lowEconomic": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "cooling": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            }
        },
        "zone2": {
            "enable": true,
            "temperatureLevel": 1,
            "temperatureMode": 1,
            "heatingCureOffsetValue": 0,
            "highComfort": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "highWarm": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "highEconomic": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "mediumComfort": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "mediumWarm": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "mediumEconomic": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "lowComfort": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "lowWarm": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "lowEconomic": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "cooling": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            }
        },
        "zone3": {
            "enable": true,
            "temperatureLevel": 1,
            "temperatureMode": 1,
            "heatingCureOffsetValue": 0,
            "highComfort": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "highWarm": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "highEconomic": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "mediumComfort": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "mediumWarm": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "mediumEconomic": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "lowComfort": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "lowWarm": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "lowEconomic": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            },
            "cooling": {
                "outdoorTemperatureLower": 0,
                "outdoorTemperatureUpper": 0,
                "waterTemperatureLower": 0,
                "waterTemperatureUpper": 0
            }
        }
    }
}'

Responses

🟢200
application/json
Bodyapplication/json

Example
Modified at 2026-09-03 05:25:36
Previous
heatingCircuitsControlsGet
Next
dhwControlsGet
Built with