Versions Compared

Old Version 2

changes.mady.by.user Simon Schweda

Saved on

compared with

New Version Current

changes.mady.by.user Stefanie Domzig

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleAPI result
Code Block
[
    {
        "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "lastName": "Mustermann",
        "firstName": "Max",
        "company": "",
        "email": "max@mustermann.com",
        "phoneNumber": "",
        "mobilePhoneNumber": "",
        "address": {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "street": "",
            "houseNumber": "",
            "postalCode": "",
            "city": "",
            "country": "DE"
        },
        "comment": "",
        "role": null
    }
]

...

GET /administration/fleet/{fleetId}

Call

{{baseURL}}/api/v1/{{portal}}/administration/fleet/{{fleet}}

Parameter

GET https://api.enerest.world/api/v1/solarCompanyXYZ/administration/fleet/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

  • baseURL = https://api.enerest.world

    • Do NOT change that! It is always the same for every user

  • portal = solarCompanyXYZ

    • Here you should add the first part of the portal domain

    • Without .enerest.world

  • plant = i.e. XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

    • Add your plants ID here

    • This ID can be found in

      • the administration/plants call or

      • in the last part of the URL when you select the plant in the portal

        • i.e. https://solarCompanyXYZ.enerest.world/administration/plants/detail/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Result

Expand
titleAPI result
Code Block
{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "ffufId": XXXX,
    "name": "fleet name",
    "fleetSize": 3242530,
    "description": "",
    "plantCount": 2,
    "plants": [
        {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "label": "4x Inverter, 4x Modulefield",
            "plantSize": 87090,
            "identifier": "XXXXXXXXXXXX",
            "address": {
                "street": "street",
                "houseNumber": "1",
                "postalCode": "XXXXX",
                "city": "city",
                "country": "DE"
            },
            "contacts": [
                {
                    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                    "lastName": "Mustermann",
                    "firstName": "Max",
                    "company": "",
                    "email": "mail@adress.com",
                    "phoneNumber": "",
                    "mobilePhoneNumber": "",
                    "address": {
                        "street": "",
                        "houseNumber": "",
                        "postalCode": "",
                        "city": "",
                        "country": "DE"
                    },
                    "comment": "",
                    "role": null
                }
            ]
        },
        {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "label": "2x SCB, 4x Inverter",
            "plantSize": 1396800,
            "identifier": "XXXXXXXXXXXX",
            "address": {
                "street": null,
                "houseNumber": null,
                "postalCode": "XXXXX",
                "city": "city",
                "country": "CH"
            },
            "contacts": [
                {
                    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                    "lastName": "Mustermann",
                    "firstName": "Max",
                    "company": "",
                    "email": "max@solar-log.com",
                    "phoneNumber": null,
                    "mobilePhoneNumber": null,
                    "address": {
                        "street": null,
                        "houseNumber": null,
                        "postalCode": null,
                        "city": null,
                        "country": "DE"
                    },
                    "comment": "",
                    "role": null
                }
            ]
        }
}

...

GET /administration/fleet/{fleetId}/plants

Call

{{baseURL}}/api/v1/{{portal}}/administration/fleet/{{fleet}}/plants

Parameter

GET https://api.enerest.world/api/v1/solarCompanyXYZ/administration/fleet/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/plants

  • baseURL = https://api.enerest.world

    • Do NOT change that! It is always the same for every user

  • portal = solarCompanyXYZ

    • Here you should add the first part of the portal domain

    • Without .enerest.world

  • plant = i.e. XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

    • Add your plants ID here

    • This ID can be found in

      • the administration/plants call or

      • in the last part of the URL when you select the plant in the portal

        • i.e. https://solarCompanyXYZ.enerest.world/administration/plants/detail/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Result

Expand
titleAPI result
Code Block
[
    {
        "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "ffufId": XXXXX,
        "label": "4x Inverter, 4x Modulefield",
        "plantSize": 87090,
        "createdAt": "2022-04-29T18:00:45+00:00",
        "functionalities": [],
        "firmware": "4.2.8 Build 117",
        "firmwareDate": "30.05.2022",
        "firmwareVersion": "V04.02.08-117-20220530",
        "deviceFullName": "Solar-Log 2000",
        "vendor": "SDS",
        "identifier": "XXXXXXXXXXXX",
        "lastDataTransfer": {
            "lastTransfer": "2024-09-10T11:15:25+02:00",
            "lastTransferType": "HTTP"
        },
        "configStatus": 0,
        "fleetCount": 1,
        "latitude": XX.XXXXXXX,
        "longitude": xx.XXXXXXX,
        "fleets": [
            "/fleet/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
        ],
        "address": {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "street": "street",
            "houseNumber": "1",
            "postalCode": "XXXXX",
            "city": "city",
            "country": "DE"
        },
        "plantCreator": 1,
        "crcVersion": 157,
        "componentsClasses": [
            "production",
            "hidden",
            "intern"
        ],
        "componentsTypes": [
            "Inverter",
            "SolarLogIntern",
            "SolarLogPowerManagement",
            "SolarLogSmartEnergy",
            "SolarLogTimings"
        ],
        "targetPercentage": 75,
        "measurementInterval": 300,
        "timezone": "+0100",
        "daylightSavingType": 1,
        "transferType": "HTTP"
    },
    {
        "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "ffufId": XXXXX,
        "label": "2x SCB, 4x Inverter",
        "plantSize": 1396800,
        "createdAt": "2023-01-12T14:21:51+00:00",
        "functionalities": [],
        "firmware": "6.1.1 Build 164",
        "firmwareDate": "03.05.2024",
        "firmwareVersion": "V06.01.01-164-20240503",
        "deviceFullName": "Solar-Log Base 2000",
        "vendor": "SDS",
        "identifier": "XXXXXXXXXXXX",
        "lastDataTransfer": {
            "lastTransfer": "2024-09-10T15:53:53+02:00",
            "lastTransferType": "HTTP"
        },
        "configStatus": 0,
        "fleetCount": 1,
        "latitude": XX.XXXXXXX,
        "longitude": X.XXXXXXX,
        "fleets": [
            "/fleet/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
        ],
        "address": {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "street": null,
            "houseNumber": null,
            "postalCode": "XXXXX",
            "city": "city",
            "country": "CH"
        },
        "plantCreator": 1,
        "crcVersion": 214,
        "componentsClasses": [
            "production",
            "hidden",
            "intern"
        ],
        "componentsTypes": [
            "Inverter",
            "SolarLogIntern",
            "StringCombinerBox",
            "SolarLogPowerManagement",
            "SolarLogSmartEnergy",
            "SolarLogTimings"
        ],
        "targetPercentage": null,
        "measurementInterval": 300,
        "timezone": "+0100",
        "daylightSavingType": 1,
        "transferType": "HTTP"
    }
]

...

GET /datasource/plant/{plant}/inverters

Call

{{baseURL}}/api/v1/{{portal}}/datasource/plant/{{plant}}/inverters

Parameter

GET https://api.enerest.world/api/v1/solarCompanyXYZ/datasource/plant/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/inverters

  • baseURL = https://api.enerest.world

    • Do NOT change that! It is always the same for every user

  • portal = solarCompanyXYZ

    • Here you should add the first part of the portal domain

    • Without .enerest.world

  • plant = i.e. XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

    • Add your plants ID here

    • This ID can be found in

      • the administration/plants call or

      • in the last part of the URL when you select the plant in the portal

        • i.e. https://solarCompanyXYZ.enerest.world/administration/plants/detail/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Result

Expand
titleAPI result
Code Block
[
    {
        "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "mpptrackers": [
            {
                "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "moduleString": null,
                "moduleStrings": [],
                "moduleField": [],
                "size": 8850,
                "name": "MPPT 1.1",
                "visualizationChannels": [
                    "ProdPdc",
                    "ProdPdcNorm",
                    "ProdUdc"
                ]
            },
            {
                "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "moduleString": null,
                "moduleStrings": [],
                "moduleField": [],
                "size": 13275,
                "name": "MPPT 1.2",
                "visualizationChannels": [
                    "ProdPdc",
                    "ProdPdcNorm",
                    "ProdUdc"
                ]
            }
        ],
        "moduleStrings": [],
        "errorDetectionSettings": {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "active": 1,
            "deviation": 10,
            "notificationEmail": true,
            "notificationSms": false,
            "notificationRelais": false,
            "notificationLed": false,
            "production": 20,
            "faultduration": 1800,
            "faultDuration": 1800,
            "alerts": 3,
            "snow": false,
            "periodstart": "11:00",
            "periodStart": "11:00",
            "periodend": "13:00",
            "periodEnd": "13:00"
        },
        "componentCommunicationSettings": {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "faultduration": 1800,
            "faultDuration": 1800,
            "periodstart": "11:00",
            "periodStart": "11:00",
            "periodend": "13:00",
            "periodEnd": "13:00"
        },
        "name": "WR 1",
        "manufacturer": "Fronius",
        "size": 22125,
        "acPower": 20000,
        "visualizationChannels": [
            "ProdPac",
            "ProdPacNorm",
            "ProdPdc",
            "ProdPdcNorm",
            "ProdEtotal",
            "ProdUac",
            "TechAv"
        ]
    },
    {
        "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "mpptrackers": [
            {
                "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "moduleString": null,
                "moduleStrings": [],
                "moduleField": [],
                "size": 8620,
                "name": "MPPT 2.1",
                "visualizationChannels": [
                    "ProdPdc",
                    "ProdPdcNorm",
                    "ProdUdc"
                ]
            },
            {
                "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "moduleString": null,
                "moduleStrings": [],
                "moduleField": [],
                "size": 13275,
                "name": "MPPT 2.2",
                "visualizationChannels": [
                    "ProdPdc",
                    "ProdPdcNorm",
                    "ProdUdc"
                ]
            }
        ],
        "moduleStrings": [],
        "errorDetectionSettings": {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "active": 1,
            "deviation": 10,
            "notificationEmail": true,
            "notificationSms": false,
            "notificationRelais": false,
            "notificationLed": false,
            "production": 20,
            "faultduration": 1800,
            "faultDuration": 1800,
            "alerts": 3,
            "snow": false,
            "periodstart": "11:00",
            "periodStart": "11:00",
            "periodend": "13:00",
            "periodEnd": "13:00"
        },
        "componentCommunicationSettings": {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "faultduration": 1800,
            "faultDuration": 1800,
            "periodstart": "11:00",
            "periodStart": "11:00",
            "periodend": "13:00",
            "periodEnd": "13:00"
        },
        "name": "WR 2",
        "manufacturer": "Fronius",
        "size": 21895,
        "acPower": 20000,
        "visualizationChannels": [
            "ProdPac",
            "ProdPacNorm",
            "ProdPdc",
            "ProdPdcNorm",
            "ProdEtotal",
            "ProdUac",
            "TechAv"
        ]
    },
    {
        "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "mpptrackers": [
            {
                "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "moduleString": null,
                "moduleStrings": [],
                "moduleField": [],
                "size": 8260,
                "name": "MPPT 3.1",
                "visualizationChannels": [
                    "ProdPdc",
                    "ProdPdcNorm",
                    "ProdUdc"
                ]
            },
            {
                "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "moduleString": null,
                "moduleStrings": [],
                "moduleField": [],
                "size": 12390,
                "name": "MPPT 3.2",
                "visualizationChannels": [
                    "ProdPdc",
                    "ProdPdcNorm",
                    "ProdUdc"
                ]
            }
        ],
        "moduleStrings": [],
        "errorDetectionSettings": {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "active": 1,
            "deviation": 10,
            "notificationEmail": true,
            "notificationSms": false,
            "notificationRelais": false,
            "notificationLed": false,
            "production": 20,
            "faultduration": 1800,
            "faultDuration": 1800,
            "alerts": 3,
            "snow": false,
            "periodstart": "11:00",
            "periodStart": "11:00",
            "periodend": "13:00",
            "periodEnd": "13:00"
        },
        "componentCommunicationSettings": {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "faultduration": 1800,
            "faultDuration": 1800,
            "periodstart": "11:00",
            "periodStart": "11:00",
            "periodend": "13:00",
            "periodEnd": "13:00"
        },
        "name": "WR 3",
        "manufacturer": "Fronius",
        "size": 20650,
        "acPower": 20000,
        "visualizationChannels": [
            "ProdPac",
            "ProdPacNorm",
            "ProdPdc",
            "ProdPdcNorm",
            "ProdEtotal",
            "ProdUac",
            "TechAv"
        ]
    },
    {
        "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "mpptrackers": [
            {
                "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "moduleString": null,
                "moduleStrings": [],
                "moduleField": [],
                "size": 10030,
                "name": "MPPT 4.1",
                "visualizationChannels": [
                    "ProdPdc",
                    "ProdPdcNorm",
                    "ProdUdc"
                ]
            },
            {
                "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "moduleString": null,
                "moduleStrings": [],
                "moduleField": [],
                "size": 12390,
                "name": "MPPT 4.2",
                "visualizationChannels": [
                    "ProdPdc",
                    "ProdPdcNorm",
                    "ProdUdc"
                ]
            }
        ],
        "moduleStrings": [],
        "errorDetectionSettings": {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "active": 1,
            "deviation": 10,
            "notificationEmail": true,
            "notificationSms": false,
            "notificationRelais": false,
            "notificationLed": false,
            "production": 20,
            "faultduration": 1800,
            "faultDuration": 1800,
            "alerts": 3,
            "snow": false,
            "periodstart": "11:00",
            "periodStart": "11:00",
            "periodend": "13:00",
            "periodEnd": "13:00"
        },
        "componentCommunicationSettings": {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "faultduration": 1800,
            "faultDuration": 1800,
            "periodstart": "11:00",
            "periodStart": "11:00",
            "periodend": "13:00",
            "periodEnd": "13:00"
        },
        "name": "WR 4",
        "manufacturer": "Fronius",
        "size": 22420,
        "acPower": 20000,
        "visualizationChannels": [
            "ProdPac",
            "ProdPacNorm",
            "ProdPdc",
            "ProdPdcNorm",
            "ProdEtotal",
            "ProdUac",
            "TechAv"
        ]
    }
]

...

GET /visualization/kpi/{plantId}

Call

{{baseURL}}/api/v1/{{portal}}/visualization/kpi/{{plant}}

Parameter

GET https://api.enerest.world/api/v1/solarCompanyXYZ/visualization/kpi/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

  • baseURL = https://api.enerest.world

    • Do NOT change that! It is always the same for every user

  • portal = solarCompanyXYZ

    • Here you should add the first part of the portal domain

    • Without .enerest.world

  • plant = i.e. XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

    • Add your plants ID here

    • This ID can be found in

      • the administration/plants call or

      • in the last part of the URL when you select the plant in the portal

        • i.e. https://solarCompanyXYZ.enerest.world/administration/plants/detail/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Result

Expand
titleAPI result