User API Advanced - Package description

Owned by Stefanie Domzig
Last updated: Sept 09, 2024 by Simon Schweda
1 min read

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

Available Calls

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

 

Description

API Call

Parameters required

Description

API Call

Parameters required

Get all assigned plants

GET /administration/plants

Get general data from one plant

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

GET /administration/plant/{plantId}

Get the adress of 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/{plantId}/inverters

Get general plant data

GET /visualization/plant/{plantId}

Get data from different channels for one plant

GET /visualization/plant/{plantId}/channels

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

Get data from different channels for one plant over the lifetime

GET /visualization/plant/{plantId}/lifetime

Get data from different channels for one plant over one year

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

Get the plant KPIs

GET /visualization/kpi/{plantId}

 

Available Parameters

Parameter

Type

Value

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”

“ConsUacPhaseTwo”

“ConsUacPhaseThree”

“ConsPacPhaseOne”

“ConsPacPhaseTwo”

“ConsPacPhaseThree”

“ConsIacPhaseOne”

“ConsIacPhaseTwo”

“ConsIacPhaseThree”

“ConsQacPhaseOne”

“ConsQacPhaseTwo”

“ConsQacPhaseThree”

“ConsEtotal”

“Temp”

“ProdPdc”

“ProdPac”

“ProdUdc”

“ProdEtotal”

“BattLoad”

“ChargePac”

“DischargePac”

“ConsCosphi”

“ConsEtotalSelfSufficiency”

“ConsFac”

“ConsPac”

“ConsPacCov”

“ConsPacUncov”

“ConsPacRaw”

“EtotalC1”

“EtotalC2”

“EtotalC3”

“ProdPacFeed”

“ProdPacNorm”

“ProdPdcNorm”

“Irradiation”

“Insolation”

“TempAmbient”

“TempModule”

“WindVelocity”

“ProdUac”

“TechAv”

“ChargeEtotal”

“DischargeEtotal”

“ConsEtotalCov”

“ConsEtotalUncov”

“ProdEtotalFeed”

“ProdEtotalNorm”