Corrective action summary¶

Corrective actions summary.

Request Format¶

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

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
language	Query	false	String	language, Chinese: zh-CN, English: en-US, default as en-US

Response Parameters¶

Name	Datatype	Description
startDate	String	start date
endDate	String	end date
siteId	String	site id
actionId	String	action id
actionName	String	action name
weeklyEnergyImpact	Double	weekly energy impact in kWh
weeklyRevenueImpact	Double	weekly revenue impact
actionCost	Double	action cost
paybackTime	Double	payback time
relevance	String	relevance
description	String	description
recommended	String	recomendation

Error Codes¶

See Common response code.

Example¶

Request Example¶

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

Response Example¶

{
    "data": [
        {
            "startDate": "2017-03-09 00:00:00",
            "endDate": "2017-03-14 00:00:00",
            "siteId": "Lnxxxxxs",
            "actionId": "high_number_of_inverter_self_restarts",
            "actionName": "Inverter self-restart",
            "weeklyEnergyImpact": 194.0,
            "weeklyRevenueImpact": 209.0,
            "actionCost": 60.0,
            "paybackTime": 0.2936,
            "description": "5 inverters have experienced a high number of self-restarts.",
            "recommended": "Field inspection recommended.",
            "relevance": "reliability"
        },
        {
            "startDate": "2017-02-23 00:00:00",
            "endDate": "2017-04-06 00:00:00",
            "siteId": "Lnxxxxxs",
            "actionId": "low_mppt_input_performance",
            "actionName": "Low inverter input performance",
            "weeklyEnergyImpact": 2803.0,
            "weeklyRevenueImpact": 3035.0,
            "actionCost": 1270.0,
            "paybackTime": 0.4293,
            "description": "45 strings have experienced a production below 90% of their neighbors' performance.",
            "recommended": "Perform visual, IV tracing and thermographic strings inspection.",
            "relevance": "performance"
        },
        {
            "startDate": "2017-03-08 00:00:00",
            "endDate": "2017-03-08 00:00:00",
            "siteId": "Lnxxxxxs",
            "actionId": "sensor_check_tmp_mod_discrepancy",
            "actionName": "Back of Module Temperature Sensor Discrepancy",
            "description": "1 back of module temperature sensors are inconsistent with ambient temperature readings",
            "recommended": "Check sensor adhesion to module, location, and calibration",
            "relevance": "data integrity"
        },
        {
            "startDate": "2017-03-24 00:00:00",
            "endDate": "2017-04-19 00:00:00",
            "siteId": "Lnxxxxxs",
            "actionId": "weather_station_sensor_unavailable_data",
            "actionName": "Weather Station Sensor Unavailable Data",
            "description": "1 weather station sensors reported no data for more than 20% of the time.",
            "recommended": "Check Sensors",
            "relevance": "data integrity"
        }
    ],
    "status": 0,
    "msg": "success"
}