/
DH-1002 Time series data retrieval

DH-1002 Time series data retrieval

POST method

Resource description

Resource description

Definition

Interface for requesting metering data

Path parameters

{function}

GetTimeSeriesDataPost

Query string parameters

Name

Type

Obligation

Note

{organisationUser}

String

Mandatory

 

{meteringPointEAN}

String(18)

Mandatory

 

{customerIdentification}

String(50)

Mandatory

 

{periodStartTS}

Timestamp

Mandatory

Start of time series

{periodEndTS}

Timestamp

Mandatory

End of time series

{resolutionDuration}

String(25)

Optional

  • If not provided, the data is retuned at the resolution at which it was stored.

  • If the provided resolution is lower than the stored resolution, no data is returned.

  • If the provided resolution is higher than the stored resolution, Datahub sums the data to match the requested resolution.

{productType}

Text(25)

Optional

8716867000030 = Active energy

8716867000047 = Reactive energy (all)

{readingType}

String(4)

Optional

BN01 = Metered

BN02 = Netted

BN03 = Energy community

If not provided, all reading types are returned.

Validation rules

The requesting party should have a valid agreement (sales, grid or authorisation agreement) with the customer for the full data period (start time -> end time) of the request. Data outside the agreement period is not returned.

Response

Metering data for the selected time period, accounting point and time step. Reactive energy is returned too, if that type of reading is available for the accounting point. (Note: Missing metering data values within the requested period will result in gaps in the timeline).

If time series type is not given in the request, then both active and reactive energy time series are returned. For the time step input parameter, the following rules apply:

  • If not provided, the data is retuned at the resolution at which it was stored.

  • If the provided resolution is lower than the stored resolution, no data is returned.

  • If the provided resolution is higher than the stored resolution, Datahub sums the data to match the requested resolution.

Request example

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

Content of the posted message:

{     "GetTimeSeriesDataRequest": {         "organisationUser": "{OrganisationUser}",         "Filters": {             "meteringPointEAN": "{MeteringPointEAN}",             "customerIdentification": "{CustomerIdentification}",             "periodStartTS": "{PeriodStartTS}",             "periodEndTS": "{PeriodEndTS}",             "resolutionDuration": "{ResolutionDuration}",             "productType": "{ProductType}",             "readingType": "{ReadingType}"         }     } }

GET method

The GET method will be discontinued when version 2.6 is deployed.

Resource description

Definition

Interface for requesting metering data

Path parameters

{function}

GetTimeSeriesData

Query string parameters

Name

Type

Obligation

Note

{organisationUser}

String

Mandatory

 

{MeteringPointEAN}

String(18)

Mandatory

 

{CustomerIdentification}

String(50)

Mandatory

 

{PeriodStartTS}

Timestamp

Mandatory

Start of time series

{PeriodEndTS}

Timestamp

Mandatory

End of time series

{ResolutionDuration}

String(25)

Optional

  • If not provided, the data is retuned at the resolution at which it was stored.

  • If the provided resolution is lower than the stored resolution, no data is returned.

  • If the provided resolution is higher than the stored resolution, Datahub sums the data to match the requested resolution.

{ProductType}

Text(25)

Optional

8716867000030 = Active energy

8716867000047 = Reactive energy (all)

{ReadingType}

String(4)

Optional

BN01 = Metered

BN02 = Netted

BN03 = Energy community

If not provided, all reading types are returned.

Validation rules

The requesting party should have a valid agreement (sales, grid or authorisation agreement) with the customer for the full data period (start time -> end time) of the request. Data outside the agreement period is not returned.

Vastaus

Metering data for the selected time period, accounting point and time step. Reactive energy is returned too, if that type of reading is available for the accounting point. (Note: Missing metering data values within the requested period will result in gaps in the timeline).

If time series type is not given in the request, then both active and reactive energy time series are returned. For the time step input parameter, the following rules apply:

  • If not provided, the data is retuned at the resolution at which it was stored.

  • If the provided resolution is lower than the stored resolution, no data is returned.

  • If the provided resolution is higher than the stored resolution, Datahub sums the data to match the requested resolution.

Esimerkkipyyntö

https://{hostname}/rest/FGR/GetTimeSeriesData?organisationUser={OrganisationUser}&meteringPointEAN={MeteringPointEAN}&customerIdentification={CustomerIdentification}&periodStartTS={PeriodStartTS}&periodEndTS={PeriodEndTS}&resolutionDuration={ResolutionDuration}&productType={ProductType}&readingType={ReadingType}

Returned metering data

DH-1002 – Get time series data return

Name

Obligation

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