XML-REST Services
Introduction
The XML-REST interfaces into the system are broken into discrete services. These
services are defined below. Some package documentation is restricted to users with
the correct user privileges.
XML-REST Common Features
There are many common features to the XML-REST services. The
XML-REST common features page discusses these.
systemprices
The 'systemprices' service returns system prices.
For the 'systemprices' service click here.
settlementrundata
The 'settlementrundata' service returns settlement run information.
For the 'settlementrundata' service click here.
bmusumddl
The 'bmusumddl' service returns BM Unit summary data.
For the 'bmusumddl' service click here.
saa_apd
The 'saa_apd' service returns SAA energy account period data.
For the 'saa_apd' service click here.
realtime
The 'realtime' service returns BMRS and derived data.
For the 'realtime' service click here.
user
The 'user' service validates a user's credentials.
For the 'user' service click here.
charting
The 'charting' service provides access to data structures defining predefined charts and reports.
For the 'charting' service click here.
aggregate
The 'aggregate' service is used to download information on entities that aggregate BM Units.
What does this mean? A power station is an aggregate of BM Units, a fuel technology type is
assigned to a BM unit by aggregating the BM Units by fuel type etc.
For the 'aggregate' service click here.
bmunit
The 'bmunit' service is used to download a list of BM Units.
For the 'bmunit' service click here.
|
