Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

All calls included in the basic package are also included in the advanced package. Only the additional calls available in the Advanced packs are listed below.

You can find the call examples for the Basic package here: User API - Basic package - Example calls

GET /administration/plants/{plantId}/address

Call

{{baseURL}}/api/v1/{{portal}}/administration/plants/{{plant}}/address

Parameter

GET https://api.enerest.world/api/v1/solarcompanyXYZ/administration/plants/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/address

  • 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

 API result
{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "street": "Street",
    "houseNumber": "1",
    "postalCode": "00000",
    "city": "City",
    "country": "XX"
}

GET /administration/plants/{plantId}/contacts

Call

{{baseURL}}/api/v1/{{portal}}/administration/plants/{{plant}}/contacts

Parameter

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

  • 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

 API result
[
    {
        "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 /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

 API result
[
    {
        "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

 API result

  • No labels