Unterbrechung der Anschlussnutzung…

START_AUFTRAGSSTATUS (NB)

POST

https://api.macoapp.de

/inbound

Startet diese Rollensichten (6):

Unterbrechung der Anschlussnutzung (Sperren) auf Anweisung des LF — NB (AWH Sperrprozesse Gas)
Unterbrechung der Anschlussnutzung (Sperren) auf Anweisung des LF — NB (GPKE Teil 2)
Wiederherstellung der Anschlussnutzung (Entsperren) auf Anweisung des LF — NB (AWH Sperrprozesse Gas)
Wiederherstellung der Anschlussnutzung (Entsperren) auf Anweisung des LF — NB (GPKE Teil 2)
Wiederherstellung der Anschlussnutzung bei Lieferbeginn — NB (AWH Sperrprozesse Gas)
Wiederherstellung der Anschlussnutzung bei Lieferbeginn — NB (GPKE Teil 2)

POST/inbound

curl https://api.macoapp.de/inbound \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "stammdaten": {
    "MARKTLOKATION": [
      {
        "marktlokationsId": "marktlokationsId"
      }
    ],
    "STATUSMITTEILUNG": [
      {
        "auftragsstatus": "GESCHEITERT",
        "positionsdaten": [
          {
            "allgemeineInformationen": {
              "info1": "info1",
              "info2": "info2",
              "info3": "info3",
              "info4": "info4",
              "info5": "info5"
            },
            "positionsnummer": 0
          }
        ],
        "statusObjekt": "MSBWECHSEL"
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "antwortstatus": "antwortstatus",
    "antwortstatusCodeliste": "antwortstatusCodeliste",
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "fertigstellungsdatum": "2024-08-25T15:00:00Z",
    "pruefidentifikator": "21039",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_AUFTRAGSSTATUS",
    "prozessId": "prozessId"
  }
}'

START_AUFTRAGSSTATUS (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	21039	21040
stammdaten*	—	object	Muss	Muss
MARKTLOKATION[ ]*	—	object[]	Muss	Muss
`marktlokationsId`*00010	Identifikationsnummer einer Marktlokation, an der Energie entweder verbraucht, oder erzeugt wird	string	Muss	Muss
STATUSMITTEILUNG[ ]*	—	object[]	Muss	Muss
`auftragsstatus`*00020	Auftragsstatus	string	Muss	Muss
`GESCHEITERT`			Muss	Muss
`ERFOLGREICH`			Muss	Muss
`LIEFERUNG_GEPLANT`			Muss	Muss
`GEPLANT`			Muss	Muss
`ZUGESTIMMT`			Muss	Muss
`WIDERSPROCHEN`			Muss	Muss
`STOERUNGSFREI`			Muss	Muss
`GESTOERT`			Muss	Muss
`FESTGESTELLTE_STOERUNG`			Muss	Muss
`VERMUTETE_STOERUNG`			Muss	Muss
`ABGELEHNT`			Muss	Muss
`BEENDET`			Muss	Muss
`ANTWORT_DRITTER`			Muss	Muss
`BESTAETIGT`			Muss	Muss
`UMGESETZT`			Muss	Muss
`ENFG_STROMSPEICHER_UND_VERLUSTENERGIE`			Muss	Muss
`ENFG_ELEKTRISCH_ANGETRIEBENE_WAERMEPUMPEN`			Muss	Muss
`ENFG_UMLAGEERHEBUNG_BEI_ANLAGEN_ZUR_VERSTROMUNG_VON_KUPPELGASEN`			Muss	Muss
`ENFG_HERSTELLUNG_VON_GRUENEN_WASSERSTOFF`			Muss	Muss
`ENFG_STROMKOSTENINTENSIVE_UNTERNEHMEN`			Muss	Muss
`ENFG_HERSTELLUNG_VON_WASSERSTOFF_IN_STROMKOSTENINTENSIVEN_UNTERNEHMEN`			Muss	Muss
`ENFG_SCHIENENBAHNEN`			Muss	Muss
`ENFG_ELEKTRISCHE_BETRIEBENE_BUSSEN_IM_LINIENVERKEHR`			Muss	Muss
`ENFG_LANDSTROMANLAGEN`			Muss	Muss
`AENDERUNG_DER_DATEN`			Muss	Muss
`KEINE_AENDERUNG_DER_DATEN`			Muss	Muss
`ZEITREIHE_AKZEPTIERT`			Muss	Muss
`ZEITREIHE_NICHT_AKZEPTIERT`			Muss	Muss
`statusObjekt`00030	Statusobjekt	string	Kann
`MSBWECHSEL`			Kann
`UMBAUMELO`			Kann
`ERSTEINBAUIMS`			Kann
`ERSTEINBAUMME`			Kann
`GERAET`			Kann
`ANGEBOTANFRAGE`			Kann
`STATUSBESTELLUNG`			Kann
`LIEFERSCHEIN`			Kann
`SPERREN`			Kann
`ENTSPERREN`			Kann
`PRIVILEGIERUNG_NACH_ENFG`			Kann
`VERAENDERUNGSSTATUS_DER_DATEN`			Kann
`TURNUSAUSLESUNG`			Kann
`PRUEFSTATUS_ANTWORT_SUMMENZEITREIHEN`			Kann
`ABWEISUNG_SUMMENZEITREIHE`			Kann
`PRUEFSTATUS_SUMMENZEITREIHE`			Kann
`DATENSTATUS_SUMMENZEITREIHE`			Kann
`ABWEISUNG_STATUSMELDUNG_AENDERUNG`			Kann
`AUSFALLARBEIT`			Kann
`FAHRPLANANTEIL`			Kann
`GEGENVORSCHLAG_AUSFALLARBEIT`			Kann
`GEGENVORSCHLAG_FAHRPLANANTEIL`			Kann
positionsdaten[ ]*	—	object[]	Muss	Muss
`positionsnummer`*00040	Positionsnummer	integer	Muss	Muss
allgemeineInformationen	—	object	Kann
`info1`00050	Allgemeine Info 1	string	Kann
`info2`00060	Allgemeine Info 2	string	Kann
`info3`00070	Allgemeine Info 3	string	Kann
`info4`00080	Allgemeine Info 4	string	Kann
`info5`00090	Allgemeine Info 5	string	Kann
transaktionsdaten*	—	object	Muss	Muss
`antwortstatus`*00100	Antwortstatus / STS+E01	string	Muss	Muss
`antwortstatusCodeliste`*00110	Antwortstatus Codeliste / STS+E01	string	Muss	Muss
`fertigstellungsdatum`*00120	fertigstellungsdatum	string (date-time)	Muss	Muss
`pruefidentifikator`00130	Wird dynamisch im Event-Prozess ermittelt (Entscheidungsgrundlage: auftragsstatus). Ein vom Sender mitgegebener Wert wird ignoriert. Im Topic mögliche Prüfis — 21039, 21040.	—	Kann	Kann
`sparte`*00140	Enthält Informationen über die Sparte	string	Muss	Muss
`STROM`			Muss	Muss
`GAS`			Muss	Muss
`FERNWAERME`			Muss	Muss
`NAHWAERME`			Muss	Muss
`WASSER`			Muss	Muss
`ABWASSER`			Muss	Muss
absender*	—	object	Muss	Muss
`rollencodenummer`00150	Gibt die Codenummer der Marktrolle an.	string	Kann	Kann
empfaenger*	—	object	Muss	Muss
`rollencodenummer`00160	Gibt die Codenummer der Marktrolle an.	string	Kann	Kann
zusatzdaten*	—	object	Muss	Muss
`eventname`*00170	—	string	Muss	Muss
`prozessId`*00180	—	string	Muss	Muss

Example Request Body

{
  "stammdaten": {
    "MARKTLOKATION": [
      {
        "marktlokationsId": "marktlokationsId"
      }
    ],
    "STATUSMITTEILUNG": [
      {
        "auftragsstatus": "GESCHEITERT",
        "positionsdaten": [
          {
            "allgemeineInformationen": {
              "info1": "info1",
              "info2": "info2",
              "info3": "info3",
              "info4": "info4",
              "info5": "info5"
            },
            "positionsnummer": 0
          }
        ],
        "statusObjekt": "MSBWECHSEL"
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "antwortstatus": "antwortstatus",
    "antwortstatusCodeliste": "antwortstatusCodeliste",
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "fertigstellungsdatum": "2024-08-25T15:00:00Z",
    "pruefidentifikator": "21039",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_AUFTRAGSSTATUS",
    "prozessId": "prozessId"
  }
}

json

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

Lieferbeginn, Lieferende von NB an LF Ergänzende Daten zum Lokationsbündel…

Prozessauslöser NB

Unterbrechung der Anschlussnutzung…

Download schema

START_AUFTRAGSSTATUS (NB)

POST

https://api.macoapp.de

/inbound

Startet diese Rollensichten (6):

POST/inbound

curl https://api.macoapp.de/inbound \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "stammdaten": {
    "MARKTLOKATION": [
      {
        "marktlokationsId": "marktlokationsId"
      }
    ],
    "STATUSMITTEILUNG": [
      {
        "auftragsstatus": "GESCHEITERT",
        "positionsdaten": [
          {
            "allgemeineInformationen": {
              "info1": "info1",
              "info2": "info2",
              "info3": "info3",
              "info4": "info4",
              "info5": "info5"
            },
            "positionsnummer": 0
          }
        ],
        "statusObjekt": "MSBWECHSEL"
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "antwortstatus": "antwortstatus",
    "antwortstatusCodeliste": "antwortstatusCodeliste",
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "fertigstellungsdatum": "2024-08-25T15:00:00Z",
    "pruefidentifikator": "21039",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_AUFTRAGSSTATUS",
    "prozessId": "prozessId"
  }
}'

START_AUFTRAGSSTATUS (NB) › Request Body

Struktur (BO4E)	Beschreibung	Format	21039	21040
stammdaten*	—	object	Muss	Muss
MARKTLOKATION[ ]*	—	object[]	Muss	Muss
`marktlokationsId`*00010	Identifikationsnummer einer Marktlokation, an der Energie entweder verbraucht, oder erzeugt wird	string	Muss	Muss
STATUSMITTEILUNG[ ]*	—	object[]	Muss	Muss
`auftragsstatus`*00020	Auftragsstatus	string	Muss	Muss
`GESCHEITERT`			Muss	Muss
`ERFOLGREICH`			Muss	Muss
`LIEFERUNG_GEPLANT`			Muss	Muss
`GEPLANT`			Muss	Muss
`ZUGESTIMMT`			Muss	Muss
`WIDERSPROCHEN`			Muss	Muss
`STOERUNGSFREI`			Muss	Muss
`GESTOERT`			Muss	Muss
`FESTGESTELLTE_STOERUNG`			Muss	Muss
`VERMUTETE_STOERUNG`			Muss	Muss
`ABGELEHNT`			Muss	Muss
`BEENDET`			Muss	Muss
`ANTWORT_DRITTER`			Muss	Muss
`BESTAETIGT`			Muss	Muss
`UMGESETZT`			Muss	Muss
`ENFG_STROMSPEICHER_UND_VERLUSTENERGIE`			Muss	Muss
`ENFG_ELEKTRISCH_ANGETRIEBENE_WAERMEPUMPEN`			Muss	Muss
`ENFG_UMLAGEERHEBUNG_BEI_ANLAGEN_ZUR_VERSTROMUNG_VON_KUPPELGASEN`			Muss	Muss
`ENFG_HERSTELLUNG_VON_GRUENEN_WASSERSTOFF`			Muss	Muss
`ENFG_STROMKOSTENINTENSIVE_UNTERNEHMEN`			Muss	Muss
`ENFG_HERSTELLUNG_VON_WASSERSTOFF_IN_STROMKOSTENINTENSIVEN_UNTERNEHMEN`			Muss	Muss
`ENFG_SCHIENENBAHNEN`			Muss	Muss
`ENFG_ELEKTRISCHE_BETRIEBENE_BUSSEN_IM_LINIENVERKEHR`			Muss	Muss
`ENFG_LANDSTROMANLAGEN`			Muss	Muss
`AENDERUNG_DER_DATEN`			Muss	Muss
`KEINE_AENDERUNG_DER_DATEN`			Muss	Muss
`ZEITREIHE_AKZEPTIERT`			Muss	Muss
`ZEITREIHE_NICHT_AKZEPTIERT`			Muss	Muss
`statusObjekt`00030	Statusobjekt	string	Kann
`MSBWECHSEL`			Kann
`UMBAUMELO`			Kann
`ERSTEINBAUIMS`			Kann
`ERSTEINBAUMME`			Kann
`GERAET`			Kann
`ANGEBOTANFRAGE`			Kann
`STATUSBESTELLUNG`			Kann
`LIEFERSCHEIN`			Kann
`SPERREN`			Kann
`ENTSPERREN`			Kann
`PRIVILEGIERUNG_NACH_ENFG`			Kann
`VERAENDERUNGSSTATUS_DER_DATEN`			Kann
`TURNUSAUSLESUNG`			Kann
`PRUEFSTATUS_ANTWORT_SUMMENZEITREIHEN`			Kann
`ABWEISUNG_SUMMENZEITREIHE`			Kann
`PRUEFSTATUS_SUMMENZEITREIHE`			Kann
`DATENSTATUS_SUMMENZEITREIHE`			Kann
`ABWEISUNG_STATUSMELDUNG_AENDERUNG`			Kann
`AUSFALLARBEIT`			Kann
`FAHRPLANANTEIL`			Kann
`GEGENVORSCHLAG_AUSFALLARBEIT`			Kann
`GEGENVORSCHLAG_FAHRPLANANTEIL`			Kann
positionsdaten[ ]*	—	object[]	Muss	Muss
`positionsnummer`*00040	Positionsnummer	integer	Muss	Muss
allgemeineInformationen	—	object	Kann
`info1`00050	Allgemeine Info 1	string	Kann
`info2`00060	Allgemeine Info 2	string	Kann
`info3`00070	Allgemeine Info 3	string	Kann
`info4`00080	Allgemeine Info 4	string	Kann
`info5`00090	Allgemeine Info 5	string	Kann
transaktionsdaten*	—	object	Muss	Muss
`antwortstatus`*00100	Antwortstatus / STS+E01	string	Muss	Muss
`antwortstatusCodeliste`*00110	Antwortstatus Codeliste / STS+E01	string	Muss	Muss
`fertigstellungsdatum`*00120	fertigstellungsdatum	string (date-time)	Muss	Muss
`pruefidentifikator`00130	Wird dynamisch im Event-Prozess ermittelt (Entscheidungsgrundlage: auftragsstatus). Ein vom Sender mitgegebener Wert wird ignoriert. Im Topic mögliche Prüfis — 21039, 21040.	—	Kann	Kann
`sparte`*00140	Enthält Informationen über die Sparte	string	Muss	Muss
`STROM`			Muss	Muss
`GAS`			Muss	Muss
`FERNWAERME`			Muss	Muss
`NAHWAERME`			Muss	Muss
`WASSER`			Muss	Muss
`ABWASSER`			Muss	Muss
absender*	—	object	Muss	Muss
`rollencodenummer`00150	Gibt die Codenummer der Marktrolle an.	string	Kann	Kann
empfaenger*	—	object	Muss	Muss
`rollencodenummer`00160	Gibt die Codenummer der Marktrolle an.	string	Kann	Kann
zusatzdaten*	—	object	Muss	Muss
`eventname`*00170	—	string	Muss	Muss
`prozessId`*00180	—	string	Muss	Muss

Example Request Body

{
  "stammdaten": {
    "MARKTLOKATION": [
      {
        "marktlokationsId": "marktlokationsId"
      }
    ],
    "STATUSMITTEILUNG": [
      {
        "auftragsstatus": "GESCHEITERT",
        "positionsdaten": [
          {
            "allgemeineInformationen": {
              "info1": "info1",
              "info2": "info2",
              "info3": "info3",
              "info4": "info4",
              "info5": "info5"
            },
            "positionsnummer": 0
          }
        ],
        "statusObjekt": "MSBWECHSEL"
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "antwortstatus": "antwortstatus",
    "antwortstatusCodeliste": "antwortstatusCodeliste",
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "fertigstellungsdatum": "2024-08-25T15:00:00Z",
    "pruefidentifikator": "21039",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_AUFTRAGSSTATUS",
    "prozessId": "prozessId"
  }
}

json

START_AUFTRAGSSTATUS (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_AUFTRAGSSTATUS der Marktrolle NB.

Schema nur dieses Ereignisses herunterladen (OpenAPI, JSON).

Hinweise zu dieser Seite

Lieferbeginn, Lieferende von NB an LF Ergänzende Daten zum Lokationsbündel…

Feedback zur Dokumentation

Feedback zur Dokumentation

Unterbrechung der Anschlussnutzung…

START_AUFTRAGSSTATUS (NB)

START_AUFTRAGSSTATUS (NB) › Request Body

START_AUFTRAGSSTATUS (NB) › Responses

Unterbrechung der Anschlussnutzung…

START_AUFTRAGSSTATUS (NB)

START_AUFTRAGSSTATUS (NB) › Request Body

START_AUFTRAGSSTATUS (NB) › Responses