Corrective action detail

Corrective actions in detail.

Request Format

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

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
id String unique id
startDate String start date
endDate String end date
siteId String site id
deviceId String device id
subDeviceId String sub device like string or weather station sensor
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
recoverable Int if recoverable, 0: is recoverable, 1: is not recoverable
description String description
recommended String recomendation

Error Codes

See Common response code.

Example

Request Example

GET
https://{apigw-address}/solar-api/v1.0/analyticsService/getCorrectiveActionDetail?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": [
        {
        "id": "bc5aafb201f79541",
        "startDate": "2017-03-25 00:00:00",
        "endDate": "2017-04-04 00:00:00",
        "actionId": "tracker_non_wind_stow",
        "deviceId": "193f34d4abc3c000",
        "description": "Tracker stow unrelated to wind events has been observed on array PS19_INV01.",
        "recommended": "Adjust tracker's backtracking schedule to minimize shade",
        "weeklyEnergyImpact": 290.0,
        "weeklyRevenueImpact": 290.0,
        "actionCost": 1280.0,
        "paybackTime": 4.419376,
        "recoverable": 0
      },
      {
        "id": "e477d6a868f8a415",
        "startDate": "2017-03-25 00:00:00.0",
        "endDate": "2017-04-04 00:00:00.0",
        "actionId": "tracker_non_wind_stow",
        "deviceId": "193f34d4ada26000",
        "description": "Tracker stow unrelated to wind events has been observed on array PS19_INV02.",
        "recommended": "Adjust tracker's backtracking schedule to minimize shade",
        "weeklyEnergyImpact": 284.0,
        "weeklyRevenueImpact": 290.0,
        "actionCost": 1280.0,
        "paybackTime": 4.512174,
        "recoverable": 1
      }
    ],
    "status": 0,
    "msg": "success"
}