Shutdown sequences¶

Shutdown sequences are aggregated inverter downtime events.

Request Format¶

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

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
shutdownSequenceId	String	shutdown sequence id
siteId	String	site id
beginTime	String	begin time of shutdown sequence
endTime	String	end time of shutdown sequence
duration	Double	duration of shutdown sequence
prodLoss	Double	production loss due to shutdown sequence
revenueLoss	Double	revenue loss due to shutdown sequence
initialCause	String	initial cause
affected	String	affected inverters

Error Codes¶

See Common response code.

Example¶

Request Example¶

GET
https://{apigw-address}/solar-api/v1.0/analyticsService/getShutdownSequence?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": [
        {
            "shutdownSequenceId": "193a309fc5226000_2017-04-12 12:20:00",
            "siteId": "193a2470ca43c000",
            "beginTime": "2017-04-12 12:20:00",
            "endTime": "2017-04-12 13:50:00",
            "duration": 90,
            "prodLoss": 47.71096,
            "revenueLoss": 267.527837,
            "initialCause": 0,
            "affected": "IN261S,IN262S,IN263S,IN264S"
        }
    ],
    "status": 0,
    "msg": "success"
}