Ergänzende Daten zum Lokationsbündel…

START_BERECHNUNGSFORMEL (NB)

POST

https://api.macoapp.de

/inbound

Startet diese Rollensichten (2):

POST/inbound

curl https://api.macoapp.de/inbound \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "stammdaten": {
    "BERECHNUNGSFORMEL": [
      {
        "gueltigkeitszeitraum": {
          "zeitraumId": 0
        },
        "notwendigkeit": "ZAEHLZEITDEFINITIONEN_WERDEN_VERWENDET",
        "rechenschrittId": 0,
        "rechenschritte": [
          {
            "aufteilungsfaktorEnergiemenge": 0,
            "energieflussrichtung": "AUSSP",
            "messlokationsId": "messlokationsId",
            "operation": "ADDITION",
            "rechenschrittBestandteilId": 0,
            "referenzRechenschrittId": 0,
            "verlustfaktorLeitung": 0,
            "verlustfaktorTrafo": 0
          }
        ]
      }
    ],
    "VERWENDUNGSZEITRAUM": [
      {
        "datenqualitaet": "ERWARTETE_DATEN",
        "verwendungAb": "2024-08-25T15:00:00Z",
        "verwendungBis": "2024-08-25T15:00:00Z",
        "zeitraumId": 0
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "lokationsId": "lokationsId",
    "lokationsTyp": "MALO",
    "pruefidentifikator": "25001",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_BERECHNUNGSFORMEL",
    "prozessId": "prozessId"
  }
}'

START_BERECHNUNGSFORMEL (NB) › Request Body

Der Rumpf dieses Aufrufs — eine Spalte je zulässigem Prüfidentifikator. Ein Wert in der Spalte heißt, dass das Feld zu diesem Prüfidentifikator gehört: Muss, wenn das Schema es verlangt, sonst Kann.

Struktur (BO4E)	Beschreibung	Format	25001
stammdaten*	—	object	Muss
BERECHNUNGSFORMEL[ ]	—	object[]	Kann
`notwendigkeit`00010	DefinitionenNotwendigkeit	string	Kann
`ZAEHLZEITDEFINITIONEN_WERDEN_VERWENDET`			Kann
`ZAEHLZEITDEFINITIONEN_WERDEN_NICHT_VERWENDET`			Kann
`DEFINITIONEN_WERDEN_VERWENDET`			Kann
`DEFINITIONEN_WERDEN_NICHT_VERWENDET`			Kann
`rechenschrittId`00020	ID des Rechenschritts [1 - 99999]	integer	Kann
gueltigkeitszeitraum	—	object	Kann
`zeitraumId`00030	zeitraumId	integer	Kann
rechenschritte[ ]	—	object[]	Kann
`aufteilungsfaktorEnergiemenge`00040	aufteilungsfaktorEnergiemenge	number (float)	Kann
`energieflussrichtung`00050	Spezifiziert die Energierichtung einer Markt- und/oder Messlokation	string	Kann
`AUSSP`			Kann
`EINSP`			Kann
`messlokationsId`00060	Die Messlokations-Identifikation. Das ist die frühere Zählpunktbezeichnung, z.B. DE 47108151234567	string	Kann
`operation`00070	Mit dieser Aufzählung können arithmetische Operationen festgelegt werden	string	Kann
`ADDITION`			Kann
`SUBTRAKTION`			Kann
`DIVISION`			Kann
`DIVIDEND`			Kann
`MULTIPLIKATION`			Kann
`POSITIVWERT`			Kann
`rechenschrittBestandteilId`00080	rechenschrittBestandteilId	integer	Kann
`referenzRechenschrittId`00090	referenzRechenschrittId	integer	Kann
`verlustfaktorLeitung`00100	verlustfaktorLeitung	number (float)	Kann
`verlustfaktorTrafo`00110	verlustfaktorTrafo	number (float)	Kann
VERWENDUNGSZEITRAUM[ ]*	—	object[]	Muss
`datenqualitaet`*00120	Datenqualitaet	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`*00130	verwendungAb	string (date-time)	Muss
`verwendungBis`00140	verwendungBis	string (date-time)	Kann
`zeitraumId`*00150	zeitraumId	integer	Muss
transaktionsdaten*	—	object	Muss
`kategorie`*00160	Qualifier aus dem Beginn der EDIFact Nachricht / BGM	string	Muss
`lokationsId`*00170	Für welche Markt- oder Messlokation gilt diese Anfrage.	string	Muss
`lokationsTyp`*00180	Typ der Lokation	string	Muss
`MALO`			Muss
`MELO`			Muss
`NELO`			Muss
`TECHNISCHE_RESSOURCE`			Muss
`pruefidentifikator`00190	Wird dynamisch im Event-Prozess ermittelt. Ein vom Sender mitgegebener Wert wird ignoriert. Im Topic mögliche Prüfis — 25001.	—	Kann
`sparte`*00200	Enthält Informationen über die Sparte	string	Muss
`STROM`			Muss
`GAS`			Muss
`FERNWAERME`			Muss
`NAHWAERME`			Muss
`WASSER`			Muss
`ABWASSER`			Muss
absender*	—	object	Muss
`rollencodenummer`00210	Gibt die Codenummer der Marktrolle an.	string	Kann
empfaenger*	—	object	Muss
`rollencodenummer`00220	Gibt die Codenummer der Marktrolle an.	string	Kann
zusatzdaten*	—	object	Muss
`eventname`*00230	—	string	Muss
`prozessId`*00240	—	string	Muss

Example Request Body

{
  "stammdaten": {
    "BERECHNUNGSFORMEL": [
      {
        "gueltigkeitszeitraum": {
          "zeitraumId": 0
        },
        "notwendigkeit": "ZAEHLZEITDEFINITIONEN_WERDEN_VERWENDET",
        "rechenschrittId": 0,
        "rechenschritte": [
          {
            "aufteilungsfaktorEnergiemenge": 0,
            "energieflussrichtung": "AUSSP",
            "messlokationsId": "messlokationsId",
            "operation": "ADDITION",
            "rechenschrittBestandteilId": 0,
            "referenzRechenschrittId": 0,
            "verlustfaktorLeitung": 0,
            "verlustfaktorTrafo": 0
          }
        ]
      }
    ],
    "VERWENDUNGSZEITRAUM": [
      {
        "datenqualitaet": "ERWARTETE_DATEN",
        "verwendungAb": "2024-08-25T15:00:00Z",
        "verwendungBis": "2024-08-25T15:00:00Z",
        "zeitraumId": 0
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "lokationsId": "lokationsId",
    "lokationsTyp": "MALO",
    "pruefidentifikator": "25001",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_BERECHNUNGSFORMEL",
    "prozessId": "prozessId"
  }
}

json

START_BERECHNUNGSFORMEL (NB) › Responses

Erfolg | Success

Struktur (BO4E)	Beschreibung	Format
`businessKey`*	Einzigartige Kennung des Geschäftsprozesses \| Unique identifier of the business process	string (uuid)
`message`*	Nachricht mit Details zum ausgelösten Event \| Message with details about the triggered event	string

Trigger-Event START_BERECHNUNGSFORMEL der Marktrolle NB.

Schema nur dieses Ereignisses herunterladen (OpenAPI, JSON).

Hinweise zu dieser Seite

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

Unterbrechung der Anschlussnutzung…Bestellung zur Stammdatenänderung an LF…

Prozessauslöser NB

Ergänzende Daten zum Lokationsbündel…

Download schema

START_BERECHNUNGSFORMEL (NB)

POST

https://api.macoapp.de

/inbound

Startet diese Rollensichten (2):

POST/inbound

curl https://api.macoapp.de/inbound \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "stammdaten": {
    "BERECHNUNGSFORMEL": [
      {
        "gueltigkeitszeitraum": {
          "zeitraumId": 0
        },
        "notwendigkeit": "ZAEHLZEITDEFINITIONEN_WERDEN_VERWENDET",
        "rechenschrittId": 0,
        "rechenschritte": [
          {
            "aufteilungsfaktorEnergiemenge": 0,
            "energieflussrichtung": "AUSSP",
            "messlokationsId": "messlokationsId",
            "operation": "ADDITION",
            "rechenschrittBestandteilId": 0,
            "referenzRechenschrittId": 0,
            "verlustfaktorLeitung": 0,
            "verlustfaktorTrafo": 0
          }
        ]
      }
    ],
    "VERWENDUNGSZEITRAUM": [
      {
        "datenqualitaet": "ERWARTETE_DATEN",
        "verwendungAb": "2024-08-25T15:00:00Z",
        "verwendungBis": "2024-08-25T15:00:00Z",
        "zeitraumId": 0
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "lokationsId": "lokationsId",
    "lokationsTyp": "MALO",
    "pruefidentifikator": "25001",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_BERECHNUNGSFORMEL",
    "prozessId": "prozessId"
  }
}'

START_BERECHNUNGSFORMEL (NB) › Request Body

Struktur (BO4E)	Beschreibung	Format	25001
stammdaten*	—	object	Muss
BERECHNUNGSFORMEL[ ]	—	object[]	Kann
`notwendigkeit`00010	DefinitionenNotwendigkeit	string	Kann
`ZAEHLZEITDEFINITIONEN_WERDEN_VERWENDET`			Kann
`ZAEHLZEITDEFINITIONEN_WERDEN_NICHT_VERWENDET`			Kann
`DEFINITIONEN_WERDEN_VERWENDET`			Kann
`DEFINITIONEN_WERDEN_NICHT_VERWENDET`			Kann
`rechenschrittId`00020	ID des Rechenschritts [1 - 99999]	integer	Kann
gueltigkeitszeitraum	—	object	Kann
`zeitraumId`00030	zeitraumId	integer	Kann
rechenschritte[ ]	—	object[]	Kann
`aufteilungsfaktorEnergiemenge`00040	aufteilungsfaktorEnergiemenge	number (float)	Kann
`energieflussrichtung`00050	Spezifiziert die Energierichtung einer Markt- und/oder Messlokation	string	Kann
`AUSSP`			Kann
`EINSP`			Kann
`messlokationsId`00060	Die Messlokations-Identifikation. Das ist die frühere Zählpunktbezeichnung, z.B. DE 47108151234567	string	Kann
`operation`00070	Mit dieser Aufzählung können arithmetische Operationen festgelegt werden	string	Kann
`ADDITION`			Kann
`SUBTRAKTION`			Kann
`DIVISION`			Kann
`DIVIDEND`			Kann
`MULTIPLIKATION`			Kann
`POSITIVWERT`			Kann
`rechenschrittBestandteilId`00080	rechenschrittBestandteilId	integer	Kann
`referenzRechenschrittId`00090	referenzRechenschrittId	integer	Kann
`verlustfaktorLeitung`00100	verlustfaktorLeitung	number (float)	Kann
`verlustfaktorTrafo`00110	verlustfaktorTrafo	number (float)	Kann
VERWENDUNGSZEITRAUM[ ]*	—	object[]	Muss
`datenqualitaet`*00120	Datenqualitaet	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`*00130	verwendungAb	string (date-time)	Muss
`verwendungBis`00140	verwendungBis	string (date-time)	Kann
`zeitraumId`*00150	zeitraumId	integer	Muss
transaktionsdaten*	—	object	Muss
`kategorie`*00160	Qualifier aus dem Beginn der EDIFact Nachricht / BGM	string	Muss
`lokationsId`*00170	Für welche Markt- oder Messlokation gilt diese Anfrage.	string	Muss
`lokationsTyp`*00180	Typ der Lokation	string	Muss
`MALO`			Muss
`MELO`			Muss
`NELO`			Muss
`TECHNISCHE_RESSOURCE`			Muss
`pruefidentifikator`00190	Wird dynamisch im Event-Prozess ermittelt. Ein vom Sender mitgegebener Wert wird ignoriert. Im Topic mögliche Prüfis — 25001.	—	Kann
`sparte`*00200	Enthält Informationen über die Sparte	string	Muss
`STROM`			Muss
`GAS`			Muss
`FERNWAERME`			Muss
`NAHWAERME`			Muss
`WASSER`			Muss
`ABWASSER`			Muss
absender*	—	object	Muss
`rollencodenummer`00210	Gibt die Codenummer der Marktrolle an.	string	Kann
empfaenger*	—	object	Muss
`rollencodenummer`00220	Gibt die Codenummer der Marktrolle an.	string	Kann
zusatzdaten*	—	object	Muss
`eventname`*00230	—	string	Muss
`prozessId`*00240	—	string	Muss

Example Request Body

{
  "stammdaten": {
    "BERECHNUNGSFORMEL": [
      {
        "gueltigkeitszeitraum": {
          "zeitraumId": 0
        },
        "notwendigkeit": "ZAEHLZEITDEFINITIONEN_WERDEN_VERWENDET",
        "rechenschrittId": 0,
        "rechenschritte": [
          {
            "aufteilungsfaktorEnergiemenge": 0,
            "energieflussrichtung": "AUSSP",
            "messlokationsId": "messlokationsId",
            "operation": "ADDITION",
            "rechenschrittBestandteilId": 0,
            "referenzRechenschrittId": 0,
            "verlustfaktorLeitung": 0,
            "verlustfaktorTrafo": 0
          }
        ]
      }
    ],
    "VERWENDUNGSZEITRAUM": [
      {
        "datenqualitaet": "ERWARTETE_DATEN",
        "verwendungAb": "2024-08-25T15:00:00Z",
        "verwendungBis": "2024-08-25T15:00:00Z",
        "zeitraumId": 0
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "lokationsId": "lokationsId",
    "lokationsTyp": "MALO",
    "pruefidentifikator": "25001",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_BERECHNUNGSFORMEL",
    "prozessId": "prozessId"
  }
}

json

START_BERECHNUNGSFORMEL (NB) › Responses

Erfolg | Success

Struktur (BO4E)	Beschreibung	Format
`businessKey`*	Einzigartige Kennung des Geschäftsprozesses \| Unique identifier of the business process	string (uuid)
`message`*	Nachricht mit Details zum ausgelösten Event \| Message with details about the triggered event	string

Trigger-Event START_BERECHNUNGSFORMEL der Marktrolle NB.

Schema nur dieses Ereignisses herunterladen (OpenAPI, JSON).

Hinweise zu dieser Seite

Unterbrechung der Anschlussnutzung…Bestellung zur Stammdatenänderung an LF…

Feedback zur Dokumentation

Feedback zur Dokumentation

Ergänzende Daten zum Lokationsbündel…

START_BERECHNUNGSFORMEL (NB)

START_BERECHNUNGSFORMEL (NB) › Request Body

START_BERECHNUNGSFORMEL (NB) › Responses

Ergänzende Daten zum Lokationsbündel…

START_BERECHNUNGSFORMEL (NB)

START_BERECHNUNGSFORMEL (NB) › Request Body

START_BERECHNUNGSFORMEL (NB) › Responses