Skip to main content

API Implementation

Authentification​

Find the details in the dedicated Authenification page.

Data Upload​

POST /upload/day/xml

Parses and saves data from XML or JSON document.

Header Parameters​

Header Parameters
X-Tenant-ID — REQUIRED
Unique tenant identification

Query Parameters​

Query Parameters
allowedDate string
Date (yyyy-MM-dd) - Provide if dispoGas should ignore any data, which is being uploaded for other days
importAllDates boolean
If true, import all dates else only allowedDate.
ignoreNominationLeadTime boolean
Ignore Nomination Lead Time. We propose to set this parameter to false. dispoGas will then not import any changes in already past periods, which may not be changed according to market rules.
ignoreIdentifierConfigFailures boolean
Ignore Identifier Config failures. If set to false, import will abort in case an externalReference can not be found in the dispoGas masterdata.
sendAll boolean
Send All and not only (re)nominations. We propose to set this paramter to false. dispoGas will only send out nominations, where value changes exists, which is according to market rules. If the parameter is not provided, dispoGas will not automatically send out nominations.

Request body​

Content-Type:

  • application/json
  • application/xml
{
  "gasDays": [
    {
      "date": "yyyy-MM-dd",
      "nominationTracks": [
        {
          "externalReference": "string",
          "periods": [
            {
              "from": "yyyy-MM-dd'T'HH:mm:ssX",
              "quantity": 0,
              "to": "yyyy-MM-dd'T'HH:mm:ssX"
            }
          ]
        }
      ]
    }
  ]
}

Body description​

gasDays​

You can upload multiple Gas days at once with this endpoint, but we recommend to make individual requests per gasday. A gasday is defined by ENTSOG as

Gasday means the period from 5:00 to 5:00 UTC the following day for winter time and from 4 :00 to 4 :00 UTC the following day when daylight saving is applied

date​

When providing the "date", please use truncated datetime of the first hour of a specific gas day.

nominationTracks​

Identifies an individual time series in a Nomantion Message. In dispoGas, each nomination track is assigned to a nomination message and is identified by an externalReference. We recommend to upload always the full set of nominationTracks, but also indiviual updates are possilbe.

externalReference​

Reference to identify a indiviual nomination track. These externalReferences can be freely definied in dispoGas and must be aligned with the indivual identification from the ETRM system. We recommend not to use system generated ids, but human readable references. Our recommendation for the logic is as following:

CounterpartyBalanceGroup@ConnectionPoint(_GasQuality)(_Direction)(_UserDefined)
periods​

Defines the quantity per period in MWh. Lowest supported granularity is hourly. We expect that a periods definition always covers the full gas day. Timestamps are to be provided in UTC.

Data Download​

GET /day/{date}/export

Returns gas day for specified date as xml or json (Accept-Language - header is taken into account).

Header Parameters​

Header Parameters
X-Tenant-ID string — REQUIRED
Unique tenant identification
accept string
application/json or xml, depending on the desired response format

Path Parameters​

Path Parameters
date string - REQUIRED
Gasday Date (yyyy-MM-dd)

Query Parameters​

Query Parameters
search string
Search query like externalReference eq "search value"
filters string
Filter
condensatePeriod boolean
Defines, if periods should be condensated. If false, return periods will always mach the lowest granularity.

Responses​

application/json​

{
  "gasDays": [
    {
      "date": "yyyy-MM-dd",
      "nominationTracks": [
        {
          "externalReference": "string",
          "periods": [
            {
              "from": "yyyy-MM-ddTHH:mm:ssZ",
              "quantity": 0.0,
              "to": "yyyy-MM-ddTHH:mm:ssZ"
            }
          ]
        }
      ]
    }
  ]
}

application/xml​

<?xml version="1.0" encoding="UTF-8"?>
<GasDayDataRootDto>
    <gasDays>
        <gasDays>
            <date>yyyy-MM-dd</date>
            <nominationTracks>
                <nominationTracks>
                    <externalReference>string</externalReference>
                    <periods>
                        <periods>
                            <from>yyyy-MM-ddTHH:mm:ssZ</from>
                            <quantity>0.0</quantity>
                            <to>yyyy-MM-ddTHH:mm:ssZ</to>
                        </periods>
                    </periods>
                </nominationTracks>
            </nominationTracks>
        </gasDays>
    </gasDays>
</GasDayDataRootDto>