/
DH-1002 Aikasarjatietojen noutaminen

DH-1002 Aikasarjatietojen noutaminen

POST-menetelmä

Resurssin kuvaus

Resurssin kuvaus

Määritelmä

Rajapinta valitun käyttöpaikan mittaustietojen pyytämiseen

Polun parametrit

{funktio}

GetTimeSeriesDataPost

Sanoman parametrit

Nimi

Tyyppi

Velvoite

Huomautus

{OrganisaationKäyttäjä}

Merkkijono

Pakollinen

 

{KäyttöpaikanEAN}

Merkkijono(18)

Pakollinen

 

{AsiakkaanTunnus}

Merkkijono(50)

Pakollinen

 

{JaksonAlku}

Aikaleima

Pakollinen

Aikasarjojen alku

{JaksonLoppu}

Aikaleima

Pakollinen

Aikasarjojen loppu

{MittauksenAika-askel}

Merkkijono(25)

Valinnainen

  • Jos ei anneta, tiedot palautetaan resoluutiolla, jolla ne on tallennettu.

  • Jos annettu resoluutio on tallennettua resoluutiota pienempi, tietoja ei palauteta.

  • Jos annettu resoluutio on tallennettua resoluutiota suurempi, datahub laskee tiedot yhteen.

{TuotteenTyyppi}

Teksti(25)

Valinnainen

8716867000030 = pätöenergia

8716867000047 = loisenergia (kaikki)

{Lukematyyppi}

Merkkijono(4)

Valinnainen

BN01 = Mitattu

BN02 = Netotettu

BN03 = Energiayhteisö

Jos tyyppiä ei anneta, palautetaan kaikkien tyyppien sarjat.

Kelpoisuussäännöt

Pyynnön esittäneellä osapuolella olisi oltava voimassa oleva sopimus (myynti-, verkko- tai valtuutussopimus) asiakkaan kanssa pyynnön koko tietojaksolta (alkamisaika -> päättymisaika). Sopimuskauden ulkopuolisia tietoja ei palauteta.

Vastaus

Valitun käyttöpaikan valitun aikavälin mittaustiedot valitun aika-askeleen mukaan. Myös loisenergia palautetaan, jos nämä mittaukset ovat käytettävissä käyttöpaikasta. (Huomautus: puuttuvat mittarin data-arvot pyydetyltä aikaväliltä aiheuttavat aukkoja aikajanaan.)

Jos pyynnössä ei anneta aikasarjatyyppiä, sekä pätö- että loisenergian aikasarjat palautetaan.

Aika-askeleen syöttöparametriin sovelletaan seuraavia sääntöjä:

  • Jos ei anneta, tiedot palautetaan resoluutiolla, jolla ne on tallennettu.

  • Jos annettu resoluutio on tallennettua resoluutiota pienempi, tietoja ei palauteta.

  • Jos annettu resoluutio on tallennettua resoluutiota suurempi, datahub laskee tiedot yhteen.

Esimerkkipyyntö

https://{palvelin}/rest/FGR/GetTimeSeriesDataPost

Sanoman sisältö:

{     "GetTimeSeriesDataRequest": {         "organisationUser": "{OrganisaationKäyttäjä}",         "Filters": {             "meteringPointEAN": "{KäyttöpaikanEAN}",             "customerIdentification": "{AsiakkaanTunnus}",             "periodStartTS": "{JaksonAlku}",             "periodEndTS": "{JaksonLoppu}",             "resolutionDuration": "{MittauksenAika-askel}",             "productType": "{TuotteenTyyppi}",             "readingType": "{Lukematyyppi}"         }     } }

GET-menetelmä

GET-menetelmä poistuu käytöstä version 2.6 käyttöönoton yhteydessä. 

Resurssin kuvaus

Määritelmä

Rajapinta valitun käyttöpaikan mittaustietojen pyytämiseen

Polun parametrit

{funktio}

GetTimeSeriesData

Kyselymerkkijonon parametrit

Nimi

Tyyppi

Velvoite

Huomautus

{organisationUser}

String

Mandatory

 

{KäyttöpaikanEAN}

Merkkijono(18)

Pakollinen

 

{AsiakkaanTunnus}

Merkkijono(50)

Pakollinen

 

{JaksonAlku}

Aikaleima

Pakollinen

Aikasarjojen alku

{JaksonLoppu}

Aikaleima

Pakollinen

Aikasarjojen loppu

{MittauksenAika-askel}

Merkkijono(25)

Valinnainen

  • Jos ei anneta, tiedot palautetaan resoluutiolla, jolla ne on tallennettu.

  • Jos annettu resoluutio on tallennettua resoluutiota pienempi, tietoja ei palauteta.

  • Jos annettu resoluutio on tallennettua resoluutiota suurempi, datahub laskee tiedot yhteen.

{TuotteenTyyppi}

Teksti(25)

Valinnainen

8716867000030 = pätöenergia

8716867000047 = loisenergia (kaikki)

{Lukematyyppi}

Merkkijono(4)

Valinnainen

BN01 = Mitattu

BN02 = Netotettu

BN03 = Energiayhteisö

Jos tyyppiä ei anneta, palautetaan kaikkien tyyppien sarjat.

Kelpoisuussäännöt

Pyynnön esittäneellä osapuolella olisi oltava voimassa oleva sopimus (myynti-, verkko- tai valtuutussopimus) asiakkaan kanssa pyynnön koko tietojaksolta (alkamisaika -> päättymisaika). Sopimuskauden ulkopuolisia tietoja ei palauteta.

Vastaus

Valitun käyttöpaikan valitun aikavälin mittaustiedot valitun aika-askeleen mukaan. Myös loisenergia palautetaan, jos nämä mittaukset ovat käytettävissä käyttöpaikasta. (Huomautus: puuttuvat mittarin data-arvot pyydetyltä aikaväliltä aiheuttavat aukkoja aikajanaan.)

Jos pyynnössä ei anneta aikasarjatyyppiä, sekä pätö- että loisenergian aikasarjat palautetaan.

Aika-askeleen syöttöparametriin sovelletaan seuraavia sääntöjä:

  • Jos ei anneta, tiedot palautetaan resoluutiolla, jolla ne on tallennettu.

  • Jos annettu resoluutio on tallennettua resoluutiota pienempi, tietoja ei palauteta.

  • Jos annettu resoluutio on tallennettua resoluutiota suurempi, datahub laskee tiedot yhteen.

Esimerkkipyyntö

https://{palvelin}/rest/FGR/GetTimeSeriesData?organisationUser={OrganisaationKäyttäjä}&meteringPointEAN={KäyttöpaikanEAN}&customerIdentification={AsiakkaanTunnus}&periodStartTS={JaksonAlku}&periodEndTS={JaksonLoppu}&resolutionDuration={MittauksenAika-askel}&productType={TuotteenTyyppi}&readingType={Lukematyyppi}

Palautetut mittaustiedot

DH-1002 – Get time series data return

Nimi

Pakollisuus

TimeSeries

0..n

MeteringPointEAN

1..1

PeriodEndTS

1..1

PeriodStartTS

1..1

ProductType

1..1

ReadingType

1..1

ResolutionDuration

1..1

UnitType

1..1

Observations

1..n

PeriodStartTime

1..1

Quality

1..1

Quantity

1..1