Help Files

Help Files:

Data Service

Introduction

The Data service is used to download data.

User Restrictions

You must have enbm and enbm_download privileges to access this data.

Calling the Service

The parameters used when calling the service are as follows:

Code Required / Optional Description
username Required The user name
password Required The password
format Required The type of format required
action Required The type of action required
more ... Optional Depending on the action selected there will be more options.

Specific Details on a per Action Basis

Dependent on the action, the request parameters and response are different. The table below specifies the actions that are supported.

Action Description
charts Get Available Charts.
resolutions Get Avaialble Resolutions.
formats Get Available Formats.
data Get Data.

> action=charts

Getting the list of available charts.

https://enbm.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=charts

> action=resolutions

Getting the list of available resolutions.

https://enbm.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=resolutions

> action=formats

Getting the list of available formats.

https://enbm.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=formats

> action=entities

Getting entity information for plants in the market.

https://enbm.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=entities

> action=data

1. The parameters used as follows are for BSUoS Price, Frequency, NIV Analysis, System Fuel Mix and System Summary chart.

Code Required/Optional Description
chart Required The chart code. The value could be bsuosprice, freq, nivanalysis, systemfuelmix or systemsummary. (See 'charts' action)
startdatetime Required The start date time in format YYYYMMDDHHMMSS.
enddatetime Required The end date time in format YYYYMMDDHHMMSS.
resolution Required The type of resolution. (See 'resolutions' action)
format Required The type of format. The value could be xml, csv or xls. (See 'formats' action)

Example :

https://enbm.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=bsuosprice&startdatetime=20180416000000&enddatetime=20180417000000&resolution=hh




2. The parameters used as follows are for System Margin Summary, Bid Volumes Summary, Offer Volumes Summary and System Generation Summary chart.

Code Required/Optional Description
chart Required The chart code. The value could be systemmarginoverall, bidvoloverall, offervoloverall or systemgenoverall. (See 'charts' action)
startdatetime Required The start date time in format YYYYMMDDHHMMSS.
enddatetime Required The end date time in format YYYYMMDDHHMMSS.
resolution Required The type of resolution. (See 'resolutions' action)
format Required The type of format. The value could be xml, csv or xls. (See 'formats' action)
series_to_plot Optional The value could be found at the chart url. See the series_to_plot section
filter Optional The value could be found at the chart url. See the filter section
*dynamic param* Optional The value could be found at the chart url. See the dynamic_param section

Example :

https://enbm.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=bidvoloverall&startdatetime=20180416000000&enddatetime=20180417000000&resolution=hh

&series_to_plot=location&filter=detailedfuel&detailedfuel=dftchp



3. The parameters used as follows are for BM Unit Bid Profile, BM Unit Offer Profile and BM Unit Operations chart.

Code Required/Optional Description
chart Required The chart code. The value could be bmbidprofile, bmofferprofile or bmops. (See 'charts' action)
startdatetime Required The start date time in format YYYYMMDDHHMMSS.
enddatetime Required The end date time in format YYYYMMDDHHMMSS.
resolution Required The type of resolution. (See 'resolutions' action)
format Required The type of format. The value could be xml, csv or xls. (See 'formats' action)
filter Optional The value could be found at the chart url. See the filter section
*dynamic param* Optional The value could be found at the chart url. See the dynamic_param section
bmunitid Optional The value could be found at the chart url. See the bmunitid section

Example :

https://enbm.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=bmofferprofile&startdatetime=20180416000000&enddatetime=20180417000000&resolution=hh

&filter=operator&operator=centrica&bmunitid=E_BRYP-1



4. The parameters used as follows are for Dynamic Data Changes chart.

Code Required/Optional Description
chart Required The chart code. The value could be dynamicdatachanges. (See 'charts' action)
startdatetime Required The start date time in format YYYYMMDDHHMMSS.
enddatetime Required The end date time in format YYYYMMDDHHMMSS.
resolution Required The type of resolution. (See 'resolutions' action)
format Required The type of format. The value could be xml, csv or xls. (See 'formats' action)
filter Optional The value could be found at the chart url. See the filter section
*dynamic param* Optional The value could be found at the chart url. See the dynamic_param section
bmunitid Optional The value could be found at the chart url. See the bmunitid section
rampupdown Optional '0' for Ramp Up and '1' for Ramp Down. Default is '0'.

Example :

https://enbm.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=dynamicdatachanges&startdatetime=20180613000000&enddatetime=20180614000000&filter=none&none=null&bmunitid=T_DRAXX-3&rampupdown=1&resolution=hh



5. The parameters used as follows are for Boundary Flows chart.

Code Required/Optional Description
chart Required The chart code. The value could be boundaryflows. (See 'charts' action)
startdatetime Required The start date time in format YYYYMMDDHHMMSS.
enddatetime Required The end date time in format YYYYMMDDHHMMSS.
resolution Required The type of resolution. (See 'resolutions' action)
format Required The type of format. The value could be xml, csv or xls. (See 'formats' action)
boundaryflows Optional The boundary flow ID. See the boundaryflows section

Example :

https://enbm.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=boundaryflows&startdatetime=20180416000000&enddatetime=20180417000000&resolution=hh

&boundaryflows=1



6. The parameters used as follows are for heatmap charts.

Code Required/Optional Description
chart Required The chart code. The value could be utilhm. (See 'charts' action)
startdatetime Required The start date time in format YYYYMMDDHHMMSS.
enddatetime Required The end date time in format YYYYMMDDHHMMSS.
resolution Required The type of resolution. (See 'resolutions' action)
format Required The type of format. The value could be xml, csv or xls. (See 'formats' action)
accdecl Optional Whether to go accepted (0) or declared (1). See the bovolhm section

Examples :

https://enbm.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=utilhm&startdatetime=20180613000000&enddatetime=20180614000000&resolution=hh

https://enbm.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=bovolhm&startdatetime=20180613000000&enddatetime=20180614000000&resolution=hh&accdecl=0&bidoffer=bid



7. The parameters used as follows are for Generation & Availability, Run Hours, Starts charts etc.

Code Required/Optional Description
chart Required The chart code. The value could be runhrs. (See 'charts' action)
startdatetime Required The start date time in format YYYYMMDDHHMMSS.
enddatetime Required The end date time in format YYYYMMDDHHMMSS.
format Required The type of format. The value could be xml, csv or xls. (See 'formats' action)
accdecl Optional Whether to go accepted (0) or declared (1). See the bovol section

Example :

https://enbm.netareports.com/dataService?username=xxx&password=yyy&format=xml&action=data&chart=bovol&startdatetime=20180416000000&enddatetime=20180417000000&accdecl=0



Optional Parameters

'series_to_plot' Parameter

The value could be found as below.
i.e. Bid Volumes Summary chart at https://enbm.netareports.com/#bidvoloverall
1. Select 'Grouping Filter'.
2. Find out the value from the URL which is 'series_to_plot=location'.
* Default value is 'series_to_plot=fuel'.

series_to_plot


'filter' Parameter

The value could be found as below.
i.e. Bid Volumes Summary chart at https://enbm.netareports.com/#bidvoloverall
1. Select 'Filter'.
2. Find out the value from the URL which is 'filter=detailedfuel'.
* Default value is 'filter=none'.

filter


'dynamic param' Parameter

The value could be found as below.
i.e. Bid Volumes Summary chart at https://enbm.netareports.com/#bidvoloverall
1. After selecting a 'Filter' value.
2. Find out the value from the URL which is 'detailedfuel=dftchp'.
* Default value is 'none=null'.

dynamic_param


'boundaryflows' Parameter

The value could be found as below.
i.e. Boundary Flows chart at https://enbm.netareports.com/#boundaryflows
1. Select 'Boundary Flow'.
2. Find out the value from the URL which is 'boundaryflows=2'.
* Default value is 'boundaryflows=1'.

boundaryflows