Table of Contents

minLevel	1
maxLevel	1
outline	false
style	none
type	list
printable	true

...

The following are examples of the API calls available in the User API Advanced package.

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

...

Table of Contents

minLevel	1
maxLevel	1
outline	false
style	none
type	list
printable	true

`GET /administration/plants/{plantId}/address`

...

Expand

title	API result

Code Block

[
    {
        "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "lastName": "Mustermann",
        "firstName": "Max",
        "company": "",
        "email": "andreas@solar-logmax@mustermann.com",
        "phoneNumber": "",
        "mobilePhoneNumber": "",
        "address": {
            "id": "e7f3fd7cXXXXXXXX-c7e8XXXX-11ecXXXX-a4c6XXXX-960000a1d181XXXXXXXXXXXX",
            "street": "",
            "houseNumber": "",
            "postalCode": "",
            "city": "",
            "country": "DE"
        },
        "comment": "",
        "role": null
    }
]

...

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

Parameter

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

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
date = today
- The date can be either
  - today or
  - any Date YYYY-MM-DD

Result

...

title	API result

Result

Expand

title	API 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}`

...

{{baseURL}}/api/v1/{{portal}}/datasourcevisualization/plantkpi/{{plant}}/epochrange?date={{date}}

Parameter

GET https://api.enerest.world/api/v1/solarCompanyXYZ/datasourcevisualization/plantkpi/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/epochrange?date=2024-05-05

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
date = 2024-05-05
- The date can be either
  - today or
  - any Date YYYY-MM-DD

Result

Expand

title	API result

Versions Compared

Old Version 1

New Version Current

Key

`GET /administration/plants/{plantId}/address`

Parameter

Result

Result

`GET /visualization/kpi/{plantId}`

Parameter

Result

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

GET /administration/plants/{plantId}/address

Parameter

Result

Result

GET /visualization/kpi/{plantId}

Parameter

Result

`GET /administration/plants/{plantId}/address`

`GET /visualization/kpi/{plantId}`