Master data on balancing group integrity

START_VERSAND_STDA_BK_TREUE (NB)

POST

https://api.macoapp.de

/inbound

Startet diese Rollensichten (1):

Stammdaten zur Bilanzkreistreue — NB

POST/inbound

curl https://api.macoapp.de/inbound \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "stammdaten": {
    "BILANZIERUNG": [
      {
        "bilanzkreis": "bilanzkreis",
        "zeitreihentyp": "EGS"
      }
    ],
    "MARKTLOKATION": [
      {
        "bilanzierungsgebiet": "bilanzierungsgebiet",
        "datenqualitaet": "ERWARTETE_DATEN",
        "gueltigkeitszeitraum": {
          "zeitraumId": 0
        },
        "marktlokationsId": "marktlokationsId",
        "marktrollen": [
          {
            "marktrolle": "NB",
            "rollencodenummer": "rollencodenummer"
          }
        ]
      }
    ],
    "TRANCHE": [
      {
        "bilanzkreis": "bilanzkreis",
        "datenqualitaet": "ERWARTETE_DATEN",
        "gueltigkeitszeitraum": {
          "zeitraumId": 0
        },
        "marktrollen": [
          {
            "marktrolle": "NB",
            "rollencodenummer": "rollencodenummer"
          }
        ],
        "tranchenId": "tranchenId"
      }
    ],
    "VERWENDUNGSZEITRAUM": [
      {
        "datenqualitaet": "ERWARTETE_DATEN",
        "verwendungAb": "2024-08-25T15:00:00Z",
        "verwendungBis": "2024-08-25T15:00:00Z",
        "zeitraumId": 0
      }
    ]
  },
  "transaktionsdaten": {
    "pruefidentifikator": "55670"
  },
  "zusatzdaten": {
    "eventname": "START_VERSAND_STDA_BK_TREUE",
    "prozessId": "prozessId"
  }
}'

START_VERSAND_STDA_BK_TREUE (NB) › Request Body

The body of this call — one column per admissible Prüfidentifikator. A value in the column means the field belongs to that Prüfidentifikator: Must where the schema requires it, otherwise May.

Structure (BO4E)	Description	Format	55670
stammdaten*	—	object	Muss
BILANZIERUNG[ ]	—	object[]	Kann
`bilanzkreis`00010	Balancing group	string	Kann
`zeitreihentyp`00020	Time series type	string	Kann
`EGS`			Kann
`LGS`			Kann
`NZR`			Kann
`SES`			Kann
`SLS`			Kann
`TES`			Kann
`TLS`			Kann
`SLS_TLS`			Kann
`SES_TES`			Kann
MARKTLOKATION[ ]*	—	object[]	Muss
`bilanzierungsgebiet`00030	Balancing area to which the grid area is assigned - in the case of an electricity grid.	string	Kann
`datenqualitaet`*00040	Data quality	string	Muss
`ERWARTETE_DATEN`			Muss
`IM_SYSTEM_VORHANDENE_DATEN`			Muss
`INFORMATIVE_DATEN`			Muss
`GUELTIGE_DATEN`			Muss
`KEINE_DATEN`			Muss
`IM_SYSTEM_KEINE_DATEN_VORHANDEN`			Muss
`KEINE_DATEN_ERWARTET`			Muss
`DIFFERENZ_DATEN`			Muss
`DIFFERENZ_ERWARTETE_DATEN`			Muss
`DIFFERENZ_IM_SYSTEM_VORHANDENE_DATEN`			Muss
`marktlokationsId`00050	Identification number of a market location at which energy is either consumed or generated	string	Kann
gueltigkeitszeitraum	—	object	Kann
`zeitraumId`00060	zeitraumId	integer	Kann
marktrollen[ ]	—	object[]	Kann
`marktrolle`00070	Indicates the designation of the market role in free text.	string	Kann
`NB`			Kann
`LF`			Kann
`MSB`			Kann
`MSBA`			Kann
`GMSB`			Kann
`MDL`			Kann
`DL`			Kann
`BKV`			Kann
`BKO`			Kann
`UENB`			Kann
`KUNDE-SELBST-NN`			Kann
`MGV`			Kann
`EIV`			Kann
`RB`			Kann
`KUNDE`			Kann
`INTERESSENT`			Kann
`KN`			Kann
`UBA`			Kann
`BIKO`			Kann
`ESA`			Kann
`rollencodenummer`00080	Specifies the code value of the market role.	string	Kann
TRANCHE[ ]	—	object[]	Kann
`bilanzkreis`00090	Balancing group	string	Kann
`datenqualitaet`00100	Data quality	string	Kann
`ERWARTETE_DATEN`			Kann
`IM_SYSTEM_VORHANDENE_DATEN`			Kann
`INFORMATIVE_DATEN`			Kann
`GUELTIGE_DATEN`			Kann
`KEINE_DATEN`			Kann
`IM_SYSTEM_KEINE_DATEN_VORHANDEN`			Kann
`KEINE_DATEN_ERWARTET`			Kann
`DIFFERENZ_DATEN`			Kann
`DIFFERENZ_ERWARTETE_DATEN`			Kann
`DIFFERENZ_IM_SYSTEM_VORHANDENE_DATEN`			Kann
`tranchenId`00110	tranchenId	string	Kann
gueltigkeitszeitraum	—	object	Kann
`zeitraumId`00120	zeitraumId	integer	Kann
marktrollen[ ]	—	object[]	Kann
`marktrolle`00130	Indicates the designation of the market role in free text.	string	Kann
`NB`			Kann
`LF`			Kann
`MSB`			Kann
`MSBA`			Kann
`GMSB`			Kann
`MDL`			Kann
`DL`			Kann
`BKV`			Kann
`BKO`			Kann
`UENB`			Kann
`KUNDE-SELBST-NN`			Kann
`MGV`			Kann
`EIV`			Kann
`RB`			Kann
`KUNDE`			Kann
`INTERESSENT`			Kann
`KN`			Kann
`UBA`			Kann
`BIKO`			Kann
`ESA`			Kann
`rollencodenummer`00140	Specifies the code value of the market role.	string	Kann
VERWENDUNGSZEITRAUM[ ]*	—	object[]	Muss
`datenqualitaet`*00150	Data quality	string	Muss
`ERWARTETE_DATEN`			Muss
`IM_SYSTEM_VORHANDENE_DATEN`			Muss
`INFORMATIVE_DATEN`			Muss
`GUELTIGE_DATEN`			Muss
`KEINE_DATEN`			Muss
`IM_SYSTEM_KEINE_DATEN_VORHANDEN`			Muss
`KEINE_DATEN_ERWARTET`			Muss
`DIFFERENZ_DATEN`			Muss
`DIFFERENZ_ERWARTETE_DATEN`			Muss
`DIFFERENZ_IM_SYSTEM_VORHANDENE_DATEN`			Muss
`verwendungAb`*00160	verwendungAb	string (date-time)	Muss
`verwendungBis`00170	verwendungBis	string (date-time)	Kann
`zeitraumId`*00180	zeitraumId	integer	Muss
transaktionsdaten*	—	object	Muss
`pruefidentifikator`00190	Determined dynamically in the event process. A value supplied by the sender is ignored. Check identifiers possible in the topic — 55670.	—	Kann
zusatzdaten*	—	object	Muss
`eventname`*00200	—	string	Muss
`prozessId`*00210	—	string	Muss

Example Request Body

{
  "stammdaten": {
    "BILANZIERUNG": [
      {
        "bilanzkreis": "bilanzkreis",
        "zeitreihentyp": "EGS"
      }
    ],
    "MARKTLOKATION": [
      {
        "bilanzierungsgebiet": "bilanzierungsgebiet",
        "datenqualitaet": "ERWARTETE_DATEN",
        "gueltigkeitszeitraum": {
          "zeitraumId": 0
        },
        "marktlokationsId": "marktlokationsId",
        "marktrollen": [
          {
            "marktrolle": "NB",
            "rollencodenummer": "rollencodenummer"
          }
        ]
      }
    ],
    "TRANCHE": [
      {
        "bilanzkreis": "bilanzkreis",
        "datenqualitaet": "ERWARTETE_DATEN",
        "gueltigkeitszeitraum": {
          "zeitraumId": 0
        },
        "marktrollen": [
          {
            "marktrolle": "NB",
            "rollencodenummer": "rollencodenummer"
          }
        ],
        "tranchenId": "tranchenId"
      }
    ],
    "VERWENDUNGSZEITRAUM": [
      {
        "datenqualitaet": "ERWARTETE_DATEN",
        "verwendungAb": "2024-08-25T15:00:00Z",
        "verwendungBis": "2024-08-25T15:00:00Z",
        "zeitraumId": 0
      }
    ]
  },
  "transaktionsdaten": {
    "pruefidentifikator": "55670"
  },
  "zusatzdaten": {
    "eventname": "START_VERSAND_STDA_BK_TREUE",
    "prozessId": "prozessId"
  }
}

json

START_VERSAND_STDA_BK_TREUE (NB) › Responses

Success | Success

Structure (BO4E)	Description	Format
`businessKey`*	Unique identifier of the business process \| Unique identifier of the business process	string (uuid)
`message`*	Message with details about the triggered event \| Message with details about the triggered event	string

Trigger-Event START_VERSAND_STDA_BK_TREUE der Marktrolle NB.

Schema nur dieses Ereignisses herunterladen (OpenAPI, JSON).

Notes on this page

Der Aufruf geht tatsächlich an POST /inbound; das Event ergibt sich aus zusatzdaten.eventname im Rumpf. Diese Seite trennt eine von 105 Rumpfvarianten heraus, damit sie einzeln lesbar und ausprobierbar sind.

Billing data for balancing group settlement, …START_VERSAND_STOERUNGSMELDUNG_NB

START_VERSAND_STDA_BK_TREUE (NB)

POST

https://api.macoapp.de

/inbound

Startet diese Rollensichten (1):

Stammdaten zur Bilanzkreistreue — NB

POST/inbound

curl https://api.macoapp.de/inbound \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "stammdaten": {
    "BILANZIERUNG": [
      {
        "bilanzkreis": "bilanzkreis",
        "zeitreihentyp": "EGS"
      }
    ],
    "MARKTLOKATION": [
      {
        "bilanzierungsgebiet": "bilanzierungsgebiet",
        "datenqualitaet": "ERWARTETE_DATEN",
        "gueltigkeitszeitraum": {
          "zeitraumId": 0
        },
        "marktlokationsId": "marktlokationsId",
        "marktrollen": [
          {
            "marktrolle": "NB",
            "rollencodenummer": "rollencodenummer"
          }
        ]
      }
    ],
    "TRANCHE": [
      {
        "bilanzkreis": "bilanzkreis",
        "datenqualitaet": "ERWARTETE_DATEN",
        "gueltigkeitszeitraum": {
          "zeitraumId": 0
        },
        "marktrollen": [
          {
            "marktrolle": "NB",
            "rollencodenummer": "rollencodenummer"
          }
        ],
        "tranchenId": "tranchenId"
      }
    ],
    "VERWENDUNGSZEITRAUM": [
      {
        "datenqualitaet": "ERWARTETE_DATEN",
        "verwendungAb": "2024-08-25T15:00:00Z",
        "verwendungBis": "2024-08-25T15:00:00Z",
        "zeitraumId": 0
      }
    ]
  },
  "transaktionsdaten": {
    "pruefidentifikator": "55670"
  },
  "zusatzdaten": {
    "eventname": "START_VERSAND_STDA_BK_TREUE",
    "prozessId": "prozessId"
  }
}'

START_VERSAND_STDA_BK_TREUE (NB) › Request Body

Structure (BO4E)	Description	Format	55670
stammdaten*	—	object	Muss
BILANZIERUNG[ ]	—	object[]	Kann
`bilanzkreis`00010	Balancing group	string	Kann
`zeitreihentyp`00020	Time series type	string	Kann
`EGS`			Kann
`LGS`			Kann
`NZR`			Kann
`SES`			Kann
`SLS`			Kann
`TES`			Kann
`TLS`			Kann
`SLS_TLS`			Kann
`SES_TES`			Kann
MARKTLOKATION[ ]*	—	object[]	Muss
`bilanzierungsgebiet`00030	Balancing area to which the grid area is assigned - in the case of an electricity grid.	string	Kann
`datenqualitaet`*00040	Data quality	string	Muss
`ERWARTETE_DATEN`			Muss
`IM_SYSTEM_VORHANDENE_DATEN`			Muss
`INFORMATIVE_DATEN`			Muss
`GUELTIGE_DATEN`			Muss
`KEINE_DATEN`			Muss
`IM_SYSTEM_KEINE_DATEN_VORHANDEN`			Muss
`KEINE_DATEN_ERWARTET`			Muss
`DIFFERENZ_DATEN`			Muss
`DIFFERENZ_ERWARTETE_DATEN`			Muss
`DIFFERENZ_IM_SYSTEM_VORHANDENE_DATEN`			Muss
`marktlokationsId`00050	Identification number of a market location at which energy is either consumed or generated	string	Kann
gueltigkeitszeitraum	—	object	Kann
`zeitraumId`00060	zeitraumId	integer	Kann
marktrollen[ ]	—	object[]	Kann
`marktrolle`00070	Indicates the designation of the market role in free text.	string	Kann
`NB`			Kann
`LF`			Kann
`MSB`			Kann
`MSBA`			Kann
`GMSB`			Kann
`MDL`			Kann
`DL`			Kann
`BKV`			Kann
`BKO`			Kann
`UENB`			Kann
`KUNDE-SELBST-NN`			Kann
`MGV`			Kann
`EIV`			Kann
`RB`			Kann
`KUNDE`			Kann
`INTERESSENT`			Kann
`KN`			Kann
`UBA`			Kann
`BIKO`			Kann
`ESA`			Kann
`rollencodenummer`00080	Specifies the code value of the market role.	string	Kann
TRANCHE[ ]	—	object[]	Kann
`bilanzkreis`00090	Balancing group	string	Kann
`datenqualitaet`00100	Data quality	string	Kann
`ERWARTETE_DATEN`			Kann
`IM_SYSTEM_VORHANDENE_DATEN`			Kann
`INFORMATIVE_DATEN`			Kann
`GUELTIGE_DATEN`			Kann
`KEINE_DATEN`			Kann
`IM_SYSTEM_KEINE_DATEN_VORHANDEN`			Kann
`KEINE_DATEN_ERWARTET`			Kann
`DIFFERENZ_DATEN`			Kann
`DIFFERENZ_ERWARTETE_DATEN`			Kann
`DIFFERENZ_IM_SYSTEM_VORHANDENE_DATEN`			Kann
`tranchenId`00110	tranchenId	string	Kann
gueltigkeitszeitraum	—	object	Kann
`zeitraumId`00120	zeitraumId	integer	Kann
marktrollen[ ]	—	object[]	Kann
`marktrolle`00130	Indicates the designation of the market role in free text.	string	Kann
`NB`			Kann
`LF`			Kann
`MSB`			Kann
`MSBA`			Kann
`GMSB`			Kann
`MDL`			Kann
`DL`			Kann
`BKV`			Kann
`BKO`			Kann
`UENB`			Kann
`KUNDE-SELBST-NN`			Kann
`MGV`			Kann
`EIV`			Kann
`RB`			Kann
`KUNDE`			Kann
`INTERESSENT`			Kann
`KN`			Kann
`UBA`			Kann
`BIKO`			Kann
`ESA`			Kann
`rollencodenummer`00140	Specifies the code value of the market role.	string	Kann
VERWENDUNGSZEITRAUM[ ]*	—	object[]	Muss
`datenqualitaet`*00150	Data quality	string	Muss
`ERWARTETE_DATEN`			Muss
`IM_SYSTEM_VORHANDENE_DATEN`			Muss
`INFORMATIVE_DATEN`			Muss
`GUELTIGE_DATEN`			Muss
`KEINE_DATEN`			Muss
`IM_SYSTEM_KEINE_DATEN_VORHANDEN`			Muss
`KEINE_DATEN_ERWARTET`			Muss
`DIFFERENZ_DATEN`			Muss
`DIFFERENZ_ERWARTETE_DATEN`			Muss
`DIFFERENZ_IM_SYSTEM_VORHANDENE_DATEN`			Muss
`verwendungAb`*00160	verwendungAb	string (date-time)	Muss
`verwendungBis`00170	verwendungBis	string (date-time)	Kann
`zeitraumId`*00180	zeitraumId	integer	Muss
transaktionsdaten*	—	object	Muss
`pruefidentifikator`00190	Determined dynamically in the event process. A value supplied by the sender is ignored. Check identifiers possible in the topic — 55670.	—	Kann
zusatzdaten*	—	object	Muss
`eventname`*00200	—	string	Muss
`prozessId`*00210	—	string	Muss

Example Request Body

{
  "stammdaten": {
    "BILANZIERUNG": [
      {
        "bilanzkreis": "bilanzkreis",
        "zeitreihentyp": "EGS"
      }
    ],
    "MARKTLOKATION": [
      {
        "bilanzierungsgebiet": "bilanzierungsgebiet",
        "datenqualitaet": "ERWARTETE_DATEN",
        "gueltigkeitszeitraum": {
          "zeitraumId": 0
        },
        "marktlokationsId": "marktlokationsId",
        "marktrollen": [
          {
            "marktrolle": "NB",
            "rollencodenummer": "rollencodenummer"
          }
        ]
      }
    ],
    "TRANCHE": [
      {
        "bilanzkreis": "bilanzkreis",
        "datenqualitaet": "ERWARTETE_DATEN",
        "gueltigkeitszeitraum": {
          "zeitraumId": 0
        },
        "marktrollen": [
          {
            "marktrolle": "NB",
            "rollencodenummer": "rollencodenummer"
          }
        ],
        "tranchenId": "tranchenId"
      }
    ],
    "VERWENDUNGSZEITRAUM": [
      {
        "datenqualitaet": "ERWARTETE_DATEN",
        "verwendungAb": "2024-08-25T15:00:00Z",
        "verwendungBis": "2024-08-25T15:00:00Z",
        "zeitraumId": 0
      }
    ]
  },
  "transaktionsdaten": {
    "pruefidentifikator": "55670"
  },
  "zusatzdaten": {
    "eventname": "START_VERSAND_STDA_BK_TREUE",
    "prozessId": "prozessId"
  }
}

json

START_VERSAND_STDA_BK_TREUE (NB) › Responses

Success | Success

Structure (BO4E)	Description	Format
`businessKey`*	Unique identifier of the business process \| Unique identifier of the business process	string (uuid)
`message`*	Message with details about the triggered event \| Message with details about the triggered event	string

Trigger-Event START_VERSAND_STDA_BK_TREUE der Marktrolle NB.

Schema nur dieses Ereignisses herunterladen (OpenAPI, JSON).

Notes on this page

Feedback on the documentation

Feedback on the documentation

Master data on balancing group integrity

START_VERSAND_STDA_BK_TREUE (NB)

START_VERSAND_STDA_BK_TREUE (NB) › Request Body

START_VERSAND_STDA_BK_TREUE (NB) › Responses

Master data on balancing group integrity

START_VERSAND_STDA_BK_TREUE (NB)

START_VERSAND_STDA_BK_TREUE (NB) › Request Body

START_VERSAND_STDA_BK_TREUE (NB) › Responses