Übermittlung von Informationen

START_UEBERMITTLUNG_ENFG (LF)

POST

https://api.macoapp.de

/inbound

Startet diese Rollensichten (1):

Übermittlung von Informationen — LF

POST/inbound

curl https://api.macoapp.de/inbound \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "stammdaten": {
    "ENERGIELIEFERVERTRAG": [
      {
        "vertragspartner2": [
          {
            "anrede": "anrede",
            "geschaeftspartnerrolle": [
              "KUNDE"
            ],
            "gewerbekennzeichnung": true,
            "name1": "name1",
            "name2": "name2",
            "name3": "name3",
            "name4": "name4"
          }
        ]
      }
    ],
    "MARKTLOKATION": [
      {
        "marktlokationsId": "marktlokationsId"
      }
    ],
    "STATUSMITTEILUNG": [
      {
        "positionsdaten": [
          {
            "allgemeineInformationen": {
              "info1": "info1",
              "info2": "info2",
              "info3": "info3",
              "info4": "info4",
              "info5": "info5"
            },
            "auftragsStatusListe": [
              "GESCHEITERT"
            ],
            "positionsnummer": 0
          }
        ]
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "pruefidentifikator": "21045",
    "sparte": "STROM",
    "verwendungAb": "2024-08-25T15:00:00Z"
  },
  "zusatzdaten": {
    "eventname": "START_UEBERMITTLUNG_ENFG",
    "prozessId": "prozessId"
  }
}'

START_UEBERMITTLUNG_ENFG (LF) › 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	21045
stammdaten*	—	object	Muss
ENERGIELIEFERVERTRAG[ ]	—	object[]	Kann
vertragspartner2[ ]	—	object[]	Kann
`anrede`00010	Die Anrede für den GePa, Z.B. Herr.	string	Kann
`geschaeftspartnerrolle`[ ]00020	Geschaeftspartnerrolle	string[]	Kann
`KUNDE`			Kann
`LIEFERANT`			Kann
`DIENSTLEISTER`			Kann
`INTERESSENT`			Kann
`MARKTPARTNER`			Kann
`EIGENTUEMER`			Kann
`HAUSVERWALTER`			Kann
`KORRESPONDENZEMPFAENGER`			Kann
`ABLESEKARTENEMPFAENGER`			Kann
`gewerbekennzeichnung`00030	Kennzeichnung ob es sich um einen Gewerbe/Unternehmen (gewerbeKennzeichnung = true) oder eine Privatperson handelt. (gewerbeKennzeichnung = false)	boolean	Kann
`name1`00040	Erster Teil des Namens. Hier kann der Firmenname oder bei Privatpersonen beispielsweise der Nachname dargestellt werden. Beispiele: Yellow Strom GmbH oder Hagen	string	Kann
`name2`00050	Zweiter Teil des Namens. Hier kann der eine Erweiterung zum Firmennamen oder bei Privatpersonen beispielsweise der Vorname dargestellt werden. Beispiele: Bereich Süd oder Nina	string	Kann
`name3`00060	Dritter Teil des Namens. Hier können weitere Ergänzungen zum Firmennamen oder bei Privatpersonen Zusätze zum Namen dargestellt werden. Beispiele: und Afrika oder Sängerin	string	Kann
`name4`00070	name4	string	Kann
MARKTLOKATION[ ]*	—	object[]	Muss
`marktlokationsId`*00080	Identifikationsnummer einer Marktlokation, an der Energie entweder verbraucht, oder erzeugt wird	string	Muss
STATUSMITTEILUNG[ ]*	—	object[]	Muss
positionsdaten[ ]*	—	object[]	Muss
`auftragsStatusListe`[ ]*00090	Auftragsstatus	string[]	Muss
`GESCHEITERT`			Muss
`ERFOLGREICH`			Muss
`LIEFERUNG_GEPLANT`			Muss
`GEPLANT`			Muss
`ZUGESTIMMT`			Muss
`WIDERSPROCHEN`			Muss
`STOERUNGSFREI`			Muss
`GESTOERT`			Muss
`FESTGESTELLTE_STOERUNG`			Muss
`VERMUTETE_STOERUNG`			Muss
`ABGELEHNT`			Muss
`BEENDET`			Muss
`ANTWORT_DRITTER`			Muss
`BESTAETIGT`			Muss
`UMGESETZT`			Muss
`ENFG_STROMSPEICHER_UND_VERLUSTENERGIE`			Muss
`ENFG_ELEKTRISCH_ANGETRIEBENE_WAERMEPUMPEN`			Muss
`ENFG_UMLAGEERHEBUNG_BEI_ANLAGEN_ZUR_VERSTROMUNG_VON_KUPPELGASEN`			Muss
`ENFG_HERSTELLUNG_VON_GRUENEN_WASSERSTOFF`			Muss
`ENFG_STROMKOSTENINTENSIVE_UNTERNEHMEN`			Muss
`ENFG_HERSTELLUNG_VON_WASSERSTOFF_IN_STROMKOSTENINTENSIVEN_UNTERNEHMEN`			Muss
`ENFG_SCHIENENBAHNEN`			Muss
`ENFG_ELEKTRISCHE_BETRIEBENE_BUSSEN_IM_LINIENVERKEHR`			Muss
`ENFG_LANDSTROMANLAGEN`			Muss
`AENDERUNG_DER_DATEN`			Muss
`KEINE_AENDERUNG_DER_DATEN`			Muss
`ZEITREIHE_AKZEPTIERT`			Muss
`ZEITREIHE_NICHT_AKZEPTIERT`			Muss
`positionsnummer`*00100	Positionsnummer	integer	Muss
allgemeineInformationen	—	object	Kann
`info1`00110	Allgemeine Info 1	string	Kann
`info2`00120	Allgemeine Info 2	string	Kann
`info3`00130	Allgemeine Info 3	string	Kann
`info4`00140	Allgemeine Info 4	string	Kann
`info5`00150	Allgemeine Info 5	string	Kann
transaktionsdaten*	—	object	Muss
`kategorie`*00160	Qualifier aus dem Beginn der EDIFact Nachricht / BGM	string	Muss
`pruefidentifikator`00170	Wird dynamisch im Event-Prozess ermittelt. Ein vom Sender mitgegebener Wert wird ignoriert. Im Topic mögliche Prüfis — 21045.	—	Kann
`sparte`*00180	Enthält Informationen über die Sparte	string	Muss
`STROM`			Muss
`GAS`			Muss
`FERNWAERME`			Muss
`NAHWAERME`			Muss
`WASSER`			Muss
`ABWASSER`			Muss
`verwendungAb`*00190	verwendungAb	string (date-time)	Muss
absender*	—	object	Muss
`rollencodenummer`00200	Gibt die Codenummer der Marktrolle an.	string	Kann
empfaenger*	—	object	Muss
`rollencodenummer`00210	Gibt die Codenummer der Marktrolle an.	string	Kann
zusatzdaten*	—	object	Muss
`eventname`*00220	—	string	Muss
`prozessId`*00230	—	string	Muss

Example Request Body

{
  "stammdaten": {
    "ENERGIELIEFERVERTRAG": [
      {
        "vertragspartner2": [
          {
            "anrede": "anrede",
            "geschaeftspartnerrolle": [
              "KUNDE"
            ],
            "gewerbekennzeichnung": true,
            "name1": "name1",
            "name2": "name2",
            "name3": "name3",
            "name4": "name4"
          }
        ]
      }
    ],
    "MARKTLOKATION": [
      {
        "marktlokationsId": "marktlokationsId"
      }
    ],
    "STATUSMITTEILUNG": [
      {
        "positionsdaten": [
          {
            "allgemeineInformationen": {
              "info1": "info1",
              "info2": "info2",
              "info3": "info3",
              "info4": "info4",
              "info5": "info5"
            },
            "auftragsStatusListe": [
              "GESCHEITERT"
            ],
            "positionsnummer": 0
          }
        ]
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "pruefidentifikator": "21045",
    "sparte": "STROM",
    "verwendungAb": "2024-08-25T15:00:00Z"
  },
  "zusatzdaten": {
    "eventname": "START_UEBERMITTLUNG_ENFG",
    "prozessId": "prozessId"
  }
}

json

START_UEBERMITTLUNG_ENFG (LF) › 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_UEBERMITTLUNG_ENFG der Marktrolle LF.

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 105 Rumpfvarianten heraus, damit sie einzeln lesbar und ausprobierbar sind.

Stornieren der Unterbrechung und…Übermittlung einer Definition des LF…

START_UEBERMITTLUNG_ENFG (LF)

POST

https://api.macoapp.de

/inbound

Startet diese Rollensichten (1):

Übermittlung von Informationen — LF

POST/inbound

curl https://api.macoapp.de/inbound \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "stammdaten": {
    "ENERGIELIEFERVERTRAG": [
      {
        "vertragspartner2": [
          {
            "anrede": "anrede",
            "geschaeftspartnerrolle": [
              "KUNDE"
            ],
            "gewerbekennzeichnung": true,
            "name1": "name1",
            "name2": "name2",
            "name3": "name3",
            "name4": "name4"
          }
        ]
      }
    ],
    "MARKTLOKATION": [
      {
        "marktlokationsId": "marktlokationsId"
      }
    ],
    "STATUSMITTEILUNG": [
      {
        "positionsdaten": [
          {
            "allgemeineInformationen": {
              "info1": "info1",
              "info2": "info2",
              "info3": "info3",
              "info4": "info4",
              "info5": "info5"
            },
            "auftragsStatusListe": [
              "GESCHEITERT"
            ],
            "positionsnummer": 0
          }
        ]
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "pruefidentifikator": "21045",
    "sparte": "STROM",
    "verwendungAb": "2024-08-25T15:00:00Z"
  },
  "zusatzdaten": {
    "eventname": "START_UEBERMITTLUNG_ENFG",
    "prozessId": "prozessId"
  }
}'

START_UEBERMITTLUNG_ENFG (LF) › Request Body

Struktur (BO4E)	Beschreibung	Format	21045
stammdaten*	—	object	Muss
ENERGIELIEFERVERTRAG[ ]	—	object[]	Kann
vertragspartner2[ ]	—	object[]	Kann
`anrede`00010	Die Anrede für den GePa, Z.B. Herr.	string	Kann
`geschaeftspartnerrolle`[ ]00020	Geschaeftspartnerrolle	string[]	Kann
`KUNDE`			Kann
`LIEFERANT`			Kann
`DIENSTLEISTER`			Kann
`INTERESSENT`			Kann
`MARKTPARTNER`			Kann
`EIGENTUEMER`			Kann
`HAUSVERWALTER`			Kann
`KORRESPONDENZEMPFAENGER`			Kann
`ABLESEKARTENEMPFAENGER`			Kann
`gewerbekennzeichnung`00030	Kennzeichnung ob es sich um einen Gewerbe/Unternehmen (gewerbeKennzeichnung = true) oder eine Privatperson handelt. (gewerbeKennzeichnung = false)	boolean	Kann
`name1`00040	Erster Teil des Namens. Hier kann der Firmenname oder bei Privatpersonen beispielsweise der Nachname dargestellt werden. Beispiele: Yellow Strom GmbH oder Hagen	string	Kann
`name2`00050	Zweiter Teil des Namens. Hier kann der eine Erweiterung zum Firmennamen oder bei Privatpersonen beispielsweise der Vorname dargestellt werden. Beispiele: Bereich Süd oder Nina	string	Kann
`name3`00060	Dritter Teil des Namens. Hier können weitere Ergänzungen zum Firmennamen oder bei Privatpersonen Zusätze zum Namen dargestellt werden. Beispiele: und Afrika oder Sängerin	string	Kann
`name4`00070	name4	string	Kann
MARKTLOKATION[ ]*	—	object[]	Muss
`marktlokationsId`*00080	Identifikationsnummer einer Marktlokation, an der Energie entweder verbraucht, oder erzeugt wird	string	Muss
STATUSMITTEILUNG[ ]*	—	object[]	Muss
positionsdaten[ ]*	—	object[]	Muss
`auftragsStatusListe`[ ]*00090	Auftragsstatus	string[]	Muss
`GESCHEITERT`			Muss
`ERFOLGREICH`			Muss
`LIEFERUNG_GEPLANT`			Muss
`GEPLANT`			Muss
`ZUGESTIMMT`			Muss
`WIDERSPROCHEN`			Muss
`STOERUNGSFREI`			Muss
`GESTOERT`			Muss
`FESTGESTELLTE_STOERUNG`			Muss
`VERMUTETE_STOERUNG`			Muss
`ABGELEHNT`			Muss
`BEENDET`			Muss
`ANTWORT_DRITTER`			Muss
`BESTAETIGT`			Muss
`UMGESETZT`			Muss
`ENFG_STROMSPEICHER_UND_VERLUSTENERGIE`			Muss
`ENFG_ELEKTRISCH_ANGETRIEBENE_WAERMEPUMPEN`			Muss
`ENFG_UMLAGEERHEBUNG_BEI_ANLAGEN_ZUR_VERSTROMUNG_VON_KUPPELGASEN`			Muss
`ENFG_HERSTELLUNG_VON_GRUENEN_WASSERSTOFF`			Muss
`ENFG_STROMKOSTENINTENSIVE_UNTERNEHMEN`			Muss
`ENFG_HERSTELLUNG_VON_WASSERSTOFF_IN_STROMKOSTENINTENSIVEN_UNTERNEHMEN`			Muss
`ENFG_SCHIENENBAHNEN`			Muss
`ENFG_ELEKTRISCHE_BETRIEBENE_BUSSEN_IM_LINIENVERKEHR`			Muss
`ENFG_LANDSTROMANLAGEN`			Muss
`AENDERUNG_DER_DATEN`			Muss
`KEINE_AENDERUNG_DER_DATEN`			Muss
`ZEITREIHE_AKZEPTIERT`			Muss
`ZEITREIHE_NICHT_AKZEPTIERT`			Muss
`positionsnummer`*00100	Positionsnummer	integer	Muss
allgemeineInformationen	—	object	Kann
`info1`00110	Allgemeine Info 1	string	Kann
`info2`00120	Allgemeine Info 2	string	Kann
`info3`00130	Allgemeine Info 3	string	Kann
`info4`00140	Allgemeine Info 4	string	Kann
`info5`00150	Allgemeine Info 5	string	Kann
transaktionsdaten*	—	object	Muss
`kategorie`*00160	Qualifier aus dem Beginn der EDIFact Nachricht / BGM	string	Muss
`pruefidentifikator`00170	Wird dynamisch im Event-Prozess ermittelt. Ein vom Sender mitgegebener Wert wird ignoriert. Im Topic mögliche Prüfis — 21045.	—	Kann
`sparte`*00180	Enthält Informationen über die Sparte	string	Muss
`STROM`			Muss
`GAS`			Muss
`FERNWAERME`			Muss
`NAHWAERME`			Muss
`WASSER`			Muss
`ABWASSER`			Muss
`verwendungAb`*00190	verwendungAb	string (date-time)	Muss
absender*	—	object	Muss
`rollencodenummer`00200	Gibt die Codenummer der Marktrolle an.	string	Kann
empfaenger*	—	object	Muss
`rollencodenummer`00210	Gibt die Codenummer der Marktrolle an.	string	Kann
zusatzdaten*	—	object	Muss
`eventname`*00220	—	string	Muss
`prozessId`*00230	—	string	Muss

Example Request Body

{
  "stammdaten": {
    "ENERGIELIEFERVERTRAG": [
      {
        "vertragspartner2": [
          {
            "anrede": "anrede",
            "geschaeftspartnerrolle": [
              "KUNDE"
            ],
            "gewerbekennzeichnung": true,
            "name1": "name1",
            "name2": "name2",
            "name3": "name3",
            "name4": "name4"
          }
        ]
      }
    ],
    "MARKTLOKATION": [
      {
        "marktlokationsId": "marktlokationsId"
      }
    ],
    "STATUSMITTEILUNG": [
      {
        "positionsdaten": [
          {
            "allgemeineInformationen": {
              "info1": "info1",
              "info2": "info2",
              "info3": "info3",
              "info4": "info4",
              "info5": "info5"
            },
            "auftragsStatusListe": [
              "GESCHEITERT"
            ],
            "positionsnummer": 0
          }
        ]
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "pruefidentifikator": "21045",
    "sparte": "STROM",
    "verwendungAb": "2024-08-25T15:00:00Z"
  },
  "zusatzdaten": {
    "eventname": "START_UEBERMITTLUNG_ENFG",
    "prozessId": "prozessId"
  }
}

json

START_UEBERMITTLUNG_ENFG (LF) › 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_UEBERMITTLUNG_ENFG der Marktrolle LF.

Schema nur dieses Ereignisses herunterladen (OpenAPI, JSON).

Hinweise zu dieser Seite

Feedback zur Dokumentation

Feedback zur Dokumentation

Übermittlung von Informationen

START_UEBERMITTLUNG_ENFG (LF)

START_UEBERMITTLUNG_ENFG (LF) › Request Body

START_UEBERMITTLUNG_ENFG (LF) › Responses

Übermittlung von Informationen

START_UEBERMITTLUNG_ENFG (LF)

START_UEBERMITTLUNG_ENFG (LF) › Request Body

START_UEBERMITTLUNG_ENFG (LF) › Responses