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 String 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-small
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-small?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": [
            {
                "bipvBuck1": 0,
......
                "vpvwn": 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

Request

Query Params
deviceSn
string 
required
SN
startDate
string 
required
Start Date
Example:
2023-10-01 00:00:00
endDate
string 
required
End Date
Example:
2023-10-31 23:59:59
pageNo
integer 
required
Page No
pageSize
integer 
required
Page Size
Header Params
Authorization
string 
required
Accept-Language
string 
required
Default:
en

Responses

🟢200OK
application/json
Body
code
integer <int32>
optional
code
data
object (Pager«OpenApiStringTypeHpsDataVo») 
optional
datas
array[object (OpenApiStringTypeHpsDataVo) {97}] 
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": [
            {
                "bipvBuck1": 0,
                "bipvBuck2": 0,
                "bipvBuck3": 0,
                "bmsStatus": 0,
                "bmsVoltStatus": 0,
                "bvbus": 0,
                "bvbusNega": 0,
                "bvbusPosi": 0,
                "bypassFreq": 0,
                "checkTime": 0,
                "deviceSn": "string",
                "ebatChargeTimeTotal": 0,
                "ebatChargeTotal": 0,
                "ebatDischargeTimeTotal": 0,
                "ebatDischargeTotal": 0,
                "echargeTimeToday": 0,
                "echargeToday": 0,
                "edischargeTimeToday": 0,
                "edischargeToday": 0,
                "effectiveness": 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,
                "gactivePower": 0,
                "gapparentPower": 0,
                "greactivePower": 0,
                "gvpvu": 0,
                "gvpvv": 0,
                "gvpvw": 0,
                "inductorCurr": 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,
                "meterPower": 0,
                "minTemp": 0,
                "minTempGroup": 0,
                "minTempNum": 0,
                "minVolt": 0,
                "minVoltCell": 0,
                "minVoltGroup": 0,
                "minVoltNum": 0,
                "mvpv": 0,
                "outvu": 0,
                "outvv": 0,
                "outvw": 0,
                "pac": 0,
                "ppv": 0,
                "ppv1": 0,
                "ppv2": 0,
                "ppv3": 0,
                "runModel": 0,
                "status": 0,
                "systemNo": 0,
                "temp": 0,
                "temp1": 0,
                "temp2": 0,
                "temp4": 0,
                "time": "string",
                "vbat": 0,
                "vpv": 0,
                "vpv2": 0,
                "vpv3": 0,
                "vpvun": 0,
                "vpvvn": 0,
                "vpvwn": 0
            }
        ],
        "offset": 0,
        "pageNo": 0,
        "pageSize": 0,
        "total": 0
    },
    "msg": "string"
}
Previous
Get String type base info of HPS list
Next
Get the latest real-time data of String type HPS
Built with