atess-server-openapi
  1. OpenAPI-PCS
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
      GET
    • Add DataLog
      POST
    • Delete DataLog
      DELETE
    • Get DataLog list
      GET
  • 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
    • Get base info of PCS list
      GET
    • Get historical data of PCS
      GET
    • Get the latest real-time data of PCS
      GET
    • Get setting of PCS
      GET
    • Modify setting of PCS
      PUT
  • 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-PCS

Get historical data of PCS

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

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/pcs/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": "string"
}
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.

PCS whose dtc is 215xx models additional parameters#

parameterdevice typedesc
runModelDTC:215XX4:Back-up Mode;5:Standard Mode
rtfPowerDTC:215XXRTF Power(kW)
rtfDemandPowerDTC:215XXRTF Demand(kW)
rtfStateDTC:215XXRTF State
rtfPowerLimitDTC:215XXRTF Power Limit(kW)

Request

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

Responses

🟢200OK
application/json
Body
code
integer <int32>
optional
code
data
object (Pager«OpenApiPcsDataVo») 
optional
datas
array[object (OpenApiPcsDataVo) {115}] 
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,
                "bmsStatus": 0,
                "bmsSystemStatus": 0,
                "bmsVoltStatus": 0,
                "breactivePower": 0,
                "bvbus": 0,
                "bypassFreq": 0,
                "capacity": 0,
                "checkTime": 0,
                "cpActivePower": 0,
                "cpPowerLimit": 0,
                "cpcu": 0,
                "cpcv": 0,
                "cpcw": 0,
                "dailyPowerGridInverter": 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,
                "dryContactState": 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,
                "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,
                "minTemp": 0,
                "minTempGroup": 0,
                "minTempNum": 0,
                "minVolt": 0,
                "minVoltCell": 0,
                "minVoltGroup": 0,
                "minVoltNum": 0,
                "mvpv": 0,
                "outActivePower": 0,
                "outApparentPower": 0,
                "outReactivePower": 0,
                "outvu": 0,
                "outvv": 0,
                "outvw": 0,
                "pac": 0,
                "pbdOutputPower": 0,
                "pcsDcPower": 0,
                "pf": 0,
                "runModel": 0,
                "status": 0,
                "sysBatteryCurr": 0,
                "systemNo": 0,
                "temp": 0,
                "temp1": 0,
                "temp4": 0,
                "time": "string",
                "totalPowerGridInverter": 0,
                "vacu": 0,
                "vacv": 0,
                "vacw": 0,
                "vbat": 0,
                "vpvuv": 0,
                "vpvvw": 0,
                "vpvwu": 0
            }
        ],
        "offset": 0,
        "pageNo": 0,
        "pageSize": 0,
        "total": 0
    },
    "msg": "string"
}
Previous
Get base info of PCS list
Next
Get the latest real-time data of PCS
Built with