Versions Compared

Old Version 3

changes.mady.by.user Stefanie Domzig

Saved on

compared with

New Version Current

changes.mady.by.user Simon Schweda

Saved on

Key

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

The With the Advanced package the user can request data from all to the user assigned plants and their components. In The Advanced package also contains the complete range of functions of the User API Basic package

Available Calls

Info

Some of the calls can be specified with parameters which allows the user to request specific data.

...

Description

API Call

Parameters required

Request Get all assigned plants

GET /administration/plants

✖️ ➖

Request Get general data from one plant

(i.e. name, size, firmware version, fleet affiliation, adress)

GET /administration/plant/{plantId}

✖️ ➖

Request Get the adress of the one plant

GET /administration/plants/{plantId}/address

✖️ ➖

Get the contact details of one plant

GET /administration/plants/{plantId}/contacts

✖️ ➖

Get components for one plant

GET /datasource/plant/{plantId}/components/{date}

✖️ ➖

Get epoch for one plant

GET /datasource/plant/{plantId}/epochrange

✖️ ➖

Get inverter data for one plant

GET /datasource/plant/{plantplantId}/inverters

✖️ ➖

Get general plant data

GET /visualization/plant/{plantId}

✖️ ➖

Get data from different channels for one plant

GET /visualization/plant/{plantId}/channels

(tick)

Get the list of available channels for one plant

GET /visualization/plant/{plantId}/channels/list

✖️ ➖

Get data from different channels for one plant regarding the epoch

GET /visualization/plant/{plantId}/cross-epoch/channels

(tick)

Get data from different channels for one plant over the lifetime

GET /visualization/plant/{plantId}/lifetime

(tick)

Get data from different channels for one plant over one year

GET /visualization/plant/{plantId}/year/{year}

(tick)

Get the plant KPIs for plant

GET /visualization/kpi/{plantId}

✖️ ➖

Available Parameters

Parameter

Type

Value

dateFrom

single

any Date “YYYY-MM-DD“, “today”

dateTo

single

any Date “YYYY-MM-DD“, “today”

componentIds[]

array

“XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX”

xComponentIds[]

array

“XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX”

mppTrackerIds[]

array

“XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX”

ModuleStringIds[]

array

“XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX”

channelNames[]

array

ConsUacPhaseOne“ConsUacPhaseOne”

ConsUacPhaseTwo“ConsUacPhaseTwo”

ConsUacPhaseThree“ConsUacPhaseThree”

ConsPacPhaseOne“ConsPacPhaseOne”

ConsPacPhaseTwo“ConsPacPhaseTwo”

ConsPacPhaseThree“ConsPacPhaseThree”

ConsIacPhaseOne“ConsIacPhaseOne”

ConsIacPhaseTwo“ConsIacPhaseTwo”

ConsIacPhaseThree“ConsIacPhaseThree”

ConsQacPhaseOne“ConsQacPhaseOne”

ConsQacPhaseTwo“ConsQacPhaseTwo”

ConsQacPhaseThree“ConsQacPhaseThree”

ConsEtotal“ConsEtotal”

Temp“Temp”

ProdPdc“ProdPdc”

ProdPac“ProdPac”

ProdUdc“ProdUdc”

ProdEtotal“ProdEtotal”

BattLoad“BattLoad”

ChargePac“ChargePac”

DischargePac“DischargePac”

ConsCosphi“ConsCosphi”

ConsEtotalSelfSufficiency“ConsEtotalSelfSufficiency”

ConsFac“ConsFac”

ConsPac“ConsPac”

ConsPacCov“ConsPacCov”

ConsPacUncov“ConsPacUncov”

ConsPacRaw“ConsPacRaw”

EtotalC1“EtotalC1”

EtotalC2“EtotalC2”

EtotalC3“EtotalC3”

ProdPacFeed“ProdPacFeed”

ProdPacNorm“ProdPacNorm”

ProdPdcNorm“ProdPdcNorm”

Irradiation“Irradiation”

Insolation“Insolation”

TempAmbient“TempAmbient”

TempModule“TempModule”

WindVelocity“WindVelocity”

ProdUac“ProdUac”

TechAv“TechAv”

ChargeEtotal“ChargeEtotal”

DischargeEtotal“DischargeEtotal”

ConsEtotalCov“ConsEtotalCov”

ConsEtotalUncov“ConsEtotalUncov”

ProdEtotalFeed“ProdEtotalFeed”

ProdEtotalNorm“ProdEtotalNorm”