Settlement API with virtual calculations

Settlement API with virtual calculations

Shared production is one of the first domains to be migrated from SOAP/XML to REST. The shared production API will eventually replace the existing BRS-NO-701. To ensure that market participants have enough time to migrate over to shared production API, BRS-NO-701 and the shared production API will be available in parallel in production for a transition period. Before prod release it will be available for testing.

Availability in test (MT1)

We are making the REST API for shared production available in Market Trial (MT1) so that market actors have sufficient time to test before go-live in production.

What can be tested (first phase)

In MT1 we now support configuration of shared production via REST (i.e. incoming messages for creating and updating shared production setups).

To create a new shared production two API calls are required;

  • create a virtual calculation

    POST /v0/virtual-calculations
  • create and activate a version of that virtual calculation

    POST /v0/virtual-calculations/{udcId}/versions

To update a shared production one call to virtual calculation/versions is required since the virtual calculation already exists.

PATCH /v0/virtual-calculations/{udcId}/versions/{versionNumber}

For outgoing messages, we will in this phase continue with the current solution:

  • Elhub will still send BRS-NO-305 to the relevant parties after a shared production setup has been created or changed.

Further development

We will explore the possibility of using Server-Sent Events (SSE) as a more modern, event-based mechanism for outgoing messages, which may eventually replace BRS-NO-305.

We will adopt CIM (Common Information Model) to our shared production API, so changes to the property names must be expected. This will be communicated when we get to that point.

Useful links

Contact information

To reach us please use our github discussions forum.

For more user specific queries use utvikler@elhub.no.