atess-server-openapi
  1. OpenAPI-HPS
atess-server-openapi
  • Record
  • 1. the first step Authorization
  • 2.the seccond step add Plant
  • 3.the third step add DataLog
  • OpenAPI-BMS
    • Get base info of BCU
      GET
    • Get base info of BCU list
      GET
    • Get historical data of BCU
      GET
    • Get the latest real-time data of BCU
      GET
    • Get setting of BUC
      GET
    • Modify setting of BCU
      PUT
    • Get base info of MBMS
      GET
    • Get base info of MBMS list
      GET
    • Get historical data of MBMS
      GET
    • Get the latest real-time data of MBMS
      GET
    • Get setting of MBMS
      GET
    • Modify setting of MBMS
      PUT
  • OpenAPI-DataLog
    • Get DataLog
    • Add DataLog
    • Delete DataLog
    • Get DataLog list
  • OpenAPI-HPS
    • Get Central type base info of HPS
      GET
    • Get Central type base info of HPS list
      GET
    • Get historical data of Central type HPS
      GET
    • Get the latest real-time data of Central type HPS
      GET
    • Get setting of Central type HPS
      GET
    • Modify setting of Central type HPS
      PUT
    • Get String type base info of HPS
      GET
    • Get String type base info of HPS list
      GET
    • Get historical data of String type HPS
      GET
    • Get the latest real-time data of String type HPS
      GET
    • Get setting of String type HPS
      GET
    • Modify setting of String type HPS
      PUT
  • OpenAPI-PBD
    • Get base info of PBD
    • Get base info of PBD list
    • Get historical data of PBD
    • Get the latest real-time data of PBD
    • Get setting of PBD
    • Modify setting of PBD
  • OpenAPI-PCS
    • Get base info of PCS
    • Get base info of PCS list
    • Get historical data of PCS
    • Get the latest real-time data of PCS
    • Get setting of PCS
    • Modify setting of PCS
  • OpenAPI-Plant
    • Get the basic information of the power station
    • Add power station
    • Modify the basic information of the power station
    • Delete power station
    • Get a list of power stations
  1. OpenAPI-HPS

Get historical data of Central type HPS

Prod Env
https://www.enerclo-atesspower.com
Prod Env
https://www.enerclo-atesspower.com
GET
https://www.enerclo-atesspower.com
/api/v1/hps/data-list
OpenAPI-HPS

Limit the frequency#

The frequency of acquisition is once every 5 minutes

Request Header#

HeaderValueDescription
Authorization############ your token ############Permission validation
Accept-LanguageenEnglish Message

Request Param#

Method : GET
https://www.enerclo-atesspower.com/api/v1/hps/data-list?deviceSn=xxxxxxxxxx&startDate=2023-10-01 00:00:00&endDate=2023-10-01 23:59:59&pageNo=1&pageSize=10

Response Body#

{
    "code": 0,
    "data": {
        "datas": [
            {
                "atsBypass": 0,
......
                "vpvwu": 0
            }
        ],
        "offset": 0,
        "pageNo": 0,
        "pageSize": 0,
        "total": 0
    },
    "msg": "operate successfully"
}
code: value 200 is a success, anything else is an exception
data: result data
msg: result message,code=200 is usually empty
codedescription
200succeed
500fail
400not fount
403No access
...Other exceptions

Response Data Description#

The corresponding field in the interface return value, if not specified, indicates that the field exists in all devices of the model. The parameters corresponding to special models are explained as follows.

HPS100HV,HPS150HV models additional parameters#

parameterdevice typedesc
bvbusHPS100HV/HPS150HVBus Voltage
vpvHPS100HV/HPS150HVPV1 Positive Voltage
vpv2HPS100HV/HPS150HVPV1 Negative Voltage
pv1VoltHPS100HV/HPS150HVPV1 Voltage
vpv3HPS100HV/HPS150HVPV2 Positive Voltage
pv2NegVoltHPS100HV/HPS150HVPV2 Negative Voltage
pv2VoltHPS100HV/HPS150HVPV2 Voltage
pv3PosVoltHPS100HV/HPS150HVPV3 Positive Voltage
pv3NegVoltHPS100HV/HPS150HVPV3 Negative Voltage
pv3VoltHPS100HV/HPS150HVPV3 Voltage
ibuck1HPS100HV/HPS150HVPV1 L_Current
ibuck2HPS100HV/HPS150HVPV2 L_Current
bipvBuck3HPS100HV/HPS150HVPV3 L_Current
ppvHPS100HV/HPS150HVPV1 Power
ppv2HPS100HV/HPS150HVPV2 Power
ppv3HPS100HV/HPS150HVPV3 Power
ppv1HPS100HV/HPS150HVTotal PV Power

Request

Query Params
deviceSn
string 
required
SN
Example:
TND0D20233
endDate
string 
required
End Date
Example:
2023-10-31 23:59:59
pageNo
integer <int32>
required
Page No
Example:
1
pageSize
integer <int32>
required
Page Size
Example:
10
startDate
string 
required
Start Date
Example:
2023-10-01 00:00:00
Header Params
Authorization
string 
required
Token
CompanyType
string 
optional
客制化
Accept-Language
string 
required
Default:
en

Responses

🟢200OK
*/*
OK
Body
code
integer <int32>
optional
code
data
object (Pager«OpenApiCentralTypeHpsDataVo») 
optional
datas
array[object (OpenApiCentralTypeHpsDataVo) {132}] 
optional
offset
integer <int32>
optional
pageNo
integer <int32>
optional
pageSize
integer <int32>
optional
total
integer <int64>
optional
msg
string 
optional
message
Example
{
  "code": 0,
  "data": {
    "datas": [
      {
        "atsBypass": 0,
        "bactivePower": 0,
        "bapparentPower": 0,
        "bipvBuck3": "string",
        "bmsStatus": 0,
        "bmsSystemStatus": 0,
        "bmsVoltStatus": 0,
        "breactivePower": 0,
        "bvbus": "string",
        "bypassFreq": 0,
        "capacity": 0,
        "checkTime": 0,
        "cpActivePower": 0,
        "cpPowerLimit": 0,
        "dailyEnergyFromMeter": 0,
        "dailyEnergyToMeter": 0,
        "dailyNonCriticalEnergy": 0,
        "deviceSn": "string",
        "dgActivePower": 0,
        "dgApparentPower": 0,
        "dgCurrentU": 0,
        "dgCurrentV": 0,
        "dgCurrentW": 0,
        "dgGridSelect": 0,
        "dgReactivePower": 0,
        "dgTodayIntakePower": 0,
        "dgTodayIntakeTime": 0,
        "dgTotalIntakePower": 0,
        "dgTotalIntakeTime": 0,
        "ebatChargeTimeTotal": 0,
        "ebatChargeTotal": 0,
        "ebatDischargeTimeTotal": 0,
        "ebatDischargeTotal": 0,
        "echargeTimeToday": 0,
        "echargeToday": 0,
        "edischargeTimeToday": 0,
        "edischargeToday": 0,
        "egridTimeToday": 0,
        "egridTimeTotal": 0,
        "egridToday": 0,
        "egridTotal": 0,
        "eloadTimeToday": 0,
        "eloadTimeTotal": 0,
        "eloadToday": 0,
        "eloadTotal": 0,
        "epvTimeToday": 0,
        "epvTimeTotal": 0,
        "epvToday": 0,
        "epvTotal": 0,
        "etoGridTimeToday": 0,
        "etoGridTimeTotal": 0,
        "etoGridToday": 0,
        "etoGridTotal": 0,
        "fac": 0,
        "gvpvuv": 0,
        "gvpvvw": 0,
        "gvpvwu": 0,
        "ibat": 0,
        "ibuck1": 0,
        "ibuck2": 0,
        "ipv": 0,
        "ipva": 0,
        "ipvb": 0,
        "ipvc": 0,
        "ipvu": 0,
        "ipvv": 0,
        "ipvw": 0,
        "loadActivePower": 0,
        "loadApparentPower": 0,
        "loadIu": 0,
        "loadIv": 0,
        "loadIw": 0,
        "loadPf": 0,
        "loadReactivePower": 0,
        "maxChargeCurr": 0,
        "maxDischargeCurr": 0,
        "maxTemp": 0,
        "maxTempGroup": 0,
        "maxTempNum": 0,
        "maxVolt": 0,
        "maxVoltCell": 0,
        "maxVoltGroup": 0,
        "maxVoltNum": 0,
        "meterCurrentU": 0,
        "meterCurrentV": 0,
        "meterCurrentW": 0,
        "meterPower": 0,
        "meterQ": 0,
        "meterS": 0,
        "minTemp": 0,
        "minTempGroup": 0,
        "minTempNum": 0,
        "minVolt": 0,
        "minVoltCell": 0,
        "minVoltGroup": 0,
        "minVoltNum": 0,
        "mvpv": 0,
        "nonCriticalLoad": 0,
        "outvu": 0,
        "outvv": 0,
        "outvw": 0,
        "pac": 0,
        "pf": 0,
        "ppv": 0,
        "ppv1": "string",
        "ppv2": "string",
        "ppv3": "string",
        "pv1Volt": "string",
        "pv2NegVolt": "string",
        "pv2Volt": "string",
        "pv3NegVolt": "string",
        "pv3PosVolt": "string",
        "pv3Volt": "string",
        "runModel": 0,
        "scrTemp": 0,
        "status": 0,
        "systemNo": 0,
        "temp": 0,
        "temp1": 0,
        "temp3": 0,
        "temp4": 0,
        "time": "string",
        "totalEnergyFromMeter": 0,
        "totalEnergyToMeter": 0,
        "totalNonCriticalEnergy": 0,
        "vbat": 0,
        "vpv": 0,
        "vpv2": "string",
        "vpv3": "string",
        "vpvuv": 0,
        "vpvvw": 0,
        "vpvwu": 0
      }
    ],
    "offset": 0,
    "pageNo": 0,
    "pageSize": 0,
    "total": 0
  },
  "msg": "string"
}
Previous
Get Central type base info of HPS list
Next
Get the latest real-time data of Central type HPS
Built with