Downtime events¶

Inverter downtime events.

Request Format¶

METHOD {URI-scheme}://{apigw-address}/solar-api/{version}/analyticsService/getDowntimeEvents

Request Parameters¶

Name	Location	Required	Datatype	Description
token	Query	false	String	token, required when user account calls Solar API
orgId	Query	false	String	orgnization Id, required when service account calls Solar API
siteId	Query	true	String	site id
begin_time	Query	true	String	begin time, format is yyyy-MM-dd HH:mm:ss
end_time	Query	true	String	end time, format is yyyy-MM-dd HH:mm:ss

Response Parameters¶

Name	Datatype	Description
eventId	String	event id
siteId	String	site id
inverterId	String	inverter id
beginTime	String	begin time of downtime event
endTime	String	end time of downtime event
duration	Double	duration of downtime event
prodLoss	Double	production loss due to downtime event
revenueLoss	Double	revenue loss due to downtime event
shutdownSequenceId	String	belong to which shutdown sequence
initialCause	String	initial cause

Error Codes¶

See Common response code.

Example¶

Request Example¶

GET
https://{apigw-address}/solar-api/v1.0/analyticsService/getDowntimeEvents?siteId=Lnxxxxxs&begin_time=2019-01-01 00:00:00&end_time=2019-12-31 00:00:00&token=APP_PORTAL_S_P3HKyz7Qpk7FUwSxxxxxxxv3M86n4ZZ

Response Example¶

{
    "data": [
        {
            "eventId": "uJxxxxx_2017-04-12 12:20:00",
            "siteId": "Lnxxxxxs",
            "inverterId": "uJxxxxx",
            "beginTime": "2017-04-12 12:20:00",
            "endTime": "2017-04-12 13:50:00",
            "duration": 90,
            "prodLoss": 47.71096,
            "revenueLoss": 267.527837,
            "shutdownSequenceId": "uJxxxxx_2017-04-12 12:20:00"
        }
    ],
    "status": 0,
    "msg": "success"
}