{ "openapi": "3.1.0", "info": { "title": "START_AUFTRAGSSTATUS (NB)", "version": "202610", "description": "Das Ereignis `START_AUFTRAGSSTATUS` der Marktrolle NB als eigenständige Spezifikation, abgeleitet aus der Auslöser-API der Formatversion 202610. Genau ein Pfad: `POST /inbound`; das Ereignis ergibt sich aus `zusatzdaten.eventname` im Rumpf." }, "servers": [ { "description": "Fake Env", "url": "https://api.macoapp.de" } ], "tags": [ { "name": "START_AUFTRAGSSTATUS" } ], "paths": { "/inbound": { "post": { "deprecated": false, "description": "Trigger-Event **START_AUFTRAGSSTATUS** der Marktrolle NB.\n\n**Startet diese Rollensichten** (6):\n\n- [Unterbrechung der Anschlussnutzung (Sperren) auf Anweisung des LF — NB (AWH Sperrprozesse Gas)](/prozessdoku/202610/NB/awh-sperrprozesse-gas-unterbrechung-der-anschlussnutzung-sperren-auf-anweisung-des-lf)\n- [Unterbrechung der Anschlussnutzung (Sperren) auf Anweisung des LF — NB (GPKE Teil 2)](/prozessdoku/202610/NB/GPKE-Teil2-unterbrechung-der-anschlussnutzung-sperren-auf-anweisung-des-lf)\n- [Wiederherstellung der Anschlussnutzung (Entsperren) auf Anweisung des LF — NB (AWH Sperrprozesse Gas)](/prozessdoku/202610/NB/awh-sperrprozesse-gas-wiederherstellung-der-anschlussnutzung-entsperren-auf-anweisung-des-lf)\n- [Wiederherstellung der Anschlussnutzung (Entsperren) auf Anweisung des LF — NB (GPKE Teil 2)](/prozessdoku/202610/NB/GPKE-Teil2-wiederherstellung-der-anschlussnutzung-entsperren-auf-anweisung-des-lf)\n- [Wiederherstellung der Anschlussnutzung bei Lieferbeginn — NB (AWH Sperrprozesse Gas)](/prozessdoku/202610/NB/awh-sperrprozesse-gas-wiederherstellung-der-anschlussnutzung-bei-lieferbeginn)\n- [Wiederherstellung der Anschlussnutzung bei Lieferbeginn — NB (GPKE Teil 2)](/prozessdoku/202610/NB/GPKE-Teil2-wiederherstellung-der-anschlussnutzung-bei-lieferbeginn)\n\nSchema nur dieses Ereignisses herunterladen (OpenAPI, JSON).\n\n\n\nDer 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.\n\n", "operationId": "trigger_NB_START_AUFTRAGSSTATUS", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NB_START_AUFTRAGSSTATUS" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_responses_success" } } }, "description": "Erfolg | Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_response_fail" } } }, "description": "Fehler | Fail" } }, "security": [ { "bearer": [] } ], "summary": "START_AUFTRAGSSTATUS (NB)", "tags": [ "START_AUFTRAGSSTATUS" ], "x-actual-endpoint": "POST /inbound", "x-event-source": "event/202610/[NB]_START_AUFTRAGSSTATUS.yaml", "x-handbuchsatz": true } } }, "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "type": "http" } }, "schemas": { "Auftragsstatus": { "description": "Auftragsstatus", "enum": [ "GESCHEITERT", "ERFOLGREICH", "LIEFERUNG_GEPLANT", "GEPLANT", "ZUGESTIMMT", "WIDERSPROCHEN", "STOERUNGSFREI", "GESTOERT", "FESTGESTELLTE_STOERUNG", "VERMUTETE_STOERUNG", "ABGELEHNT", "BEENDET", "ANTWORT_DRITTER", "BESTAETIGT", "UMGESETZT", "ENFG_STROMSPEICHER_UND_VERLUSTENERGIE", "ENFG_ELEKTRISCH_ANGETRIEBENE_WAERMEPUMPEN", "ENFG_UMLAGEERHEBUNG_BEI_ANLAGEN_ZUR_VERSTROMUNG_VON_KUPPELGASEN", "ENFG_HERSTELLUNG_VON_GRUENEN_WASSERSTOFF", "ENFG_STROMKOSTENINTENSIVE_UNTERNEHMEN", "ENFG_HERSTELLUNG_VON_WASSERSTOFF_IN_STROMKOSTENINTENSIVEN_UNTERNEHMEN", "ENFG_SCHIENENBAHNEN", "ENFG_ELEKTRISCHE_BETRIEBENE_BUSSEN_IM_LINIENVERKEHR", "ENFG_LANDSTROMANLAGEN", "AENDERUNG_DER_DATEN", "KEINE_AENDERUNG_DER_DATEN", "ZEITREIHE_AKZEPTIERT", "ZEITREIHE_NICHT_AKZEPTIERT" ], "title": "Auftragsstatus", "type": "string" }, "NB_START_AUFTRAGSSTATUS": { "properties": { "stammdaten": { "anyOf": [ { "$ref": "#/components/schemas/PI_21039__stammdaten" }, { "$ref": "#/components/schemas/PI_21040__stammdaten" } ] }, "transaktionsdaten": { "properties": { "absender": { "properties": { "rollencodenummer": { "$ref": "#/components/schemas/rollencodenummer" } }, "type": "object" }, "empfaenger": { "properties": { "rollencodenummer": { "$ref": "#/components/schemas/rollencodenummer" } }, "type": "object" }, "pruefidentifikator": { "description": "Wird dynamisch im Event-Prozess ermittelt (Entscheidungsgrundlage: auftragsstatus). Ein vom Sender mitgegebener Wert wird ignoriert. Im Topic mögliche Prüfis — 21039, 21040.", "examples": [ "21039", "21040" ] }, "sparte": { "$ref": "#/components/schemas/sparte" } }, "required": [ "absender", "empfaenger", "sparte" ], "type": "object" }, "zusatzdaten": { "properties": { "eventname": { "const": "START_AUFTRAGSSTATUS", "default": "START_AUFTRAGSSTATUS", "type": "string" }, "prozessId": { "type": "string" } }, "required": [ "prozessId", "eventname" ], "type": "object" } }, "required": [ "stammdaten", "transaktionsdaten", "zusatzdaten" ], "type": "object", "x-unresolved-routing": [ { "conditions": [ "${auftragsstatus!=\"GEPLANT\"}", "${auftragsstatus==\"GEPLANT\"}" ], "discriminates": true, "selects-pruefis": [ "21039", "21040" ], "variable": "auftragsstatus" } ] }, "PI_21039__stammdaten": { "properties": { "STATUSMITTEILUNG": { "items": { "$ref": "#/components/schemas/PI_21039__stammdaten__STATUSMITTEILUNG" }, "type": "array" } }, "required": [ "STATUSMITTEILUNG" ], "type": "object", "title": "21039" }, "PI_21039__stammdaten__STATUSMITTEILUNG": { "properties": { "positionsdaten": { "items": { "$ref": "#/components/schemas/PI_21039__stammdaten__STATUSMITTEILUNG__positionsdaten" }, "type": "array" } }, "required": [ "positionsdaten" ], "type": "object" }, "PI_21039__stammdaten__STATUSMITTEILUNG__positionsdaten": { "properties": { "allgemeineInformationenText": { "$ref": "#/components/schemas/allgemeineInformationenText", "x-edifact-segment": [ "SG14.CNI.SG15.STS+Z37.SG25.GID.FTX+ACB", "SG14.CNI.SG15.STS+Z38.SG25.GID.FTX+ACB" ] }, "antwortstatus": { "$ref": "#/components/schemas/antwortstatus", "x-edifact-segment": [ "SG14.CNI.SG15.STS+Z37", "SG14.CNI.SG15.STS+Z38" ] }, "antwortstatusCodeliste": { "$ref": "#/components/schemas/antwortstatusCodeliste", "x-edifact-segment": [ "SG14.CNI.SG15.STS+Z37", "SG14.CNI.SG15.STS+Z38" ] }, "auftragsstatus": { "$ref": "#/components/schemas/auftragsstatus", "x-edifact-segment": [ "SG14.CNI.SG15.STS+Z37", "SG14.CNI.SG15.STS+Z38" ] }, "fertigstellungsdatum": { "$ref": "#/components/schemas/fertigstellungsdatum", "x-edifact-segment": [ "SG14.CNI.SG15.STS+Z37.DTM+293", "SG14.CNI.SG15.STS+Z38.DTM+293" ] }, "lokationsId": { "$ref": "#/components/schemas/lokationsId", "x-edifact-segment": [ "SG14.CNI.LOC+172" ] }, "positionsnummer": { "$ref": "#/components/schemas/positionsnummer", "x-edifact-segment": [ "SG14.CNI" ] }, "sendungsposition": { "$ref": "#/components/schemas/sendungsposition", "x-edifact-segment": [ "SG14.CNI.SG15.STS+Z37.SG25.GID", "SG14.CNI.SG15.STS+Z38.SG25.GID" ] }, "statusObjekt": { "$ref": "#/components/schemas/statusObjekt", "x-edifact-segment": [ "SG14.CNI.SG15.STS+Z37", "SG14.CNI.SG15.STS+Z38" ] } }, "required": [ "lokationsId", "positionsnummer" ], "type": "object" }, "PI_21040__stammdaten": { "properties": { "STATUSMITTEILUNG": { "items": { "$ref": "#/components/schemas/PI_21040__stammdaten__STATUSMITTEILUNG" }, "type": "array" } }, "required": [ "STATUSMITTEILUNG" ], "type": "object", "title": "21040" }, "PI_21040__stammdaten__STATUSMITTEILUNG": { "properties": { "positionsdaten": { "items": { "$ref": "#/components/schemas/PI_21040__stammdaten__STATUSMITTEILUNG__positionsdaten" }, "type": "array" } }, "required": [ "positionsdaten" ], "type": "object" }, "PI_21040__stammdaten__STATUSMITTEILUNG__positionsdaten": { "properties": { "auftragsstatus": { "$ref": "#/components/schemas/auftragsstatus", "x-edifact-segment": [ "SG14.CNI.SG15.STS+Z39" ] }, "fertigstellungsdatum": { "$ref": "#/components/schemas/fertigstellungsdatum", "x-edifact-segment": [ "SG14.CNI.SG15.STS+Z39.DTM+293" ] }, "lokationsId": { "$ref": "#/components/schemas/lokationsId", "x-edifact-segment": [ "SG14.CNI.LOC+172" ] }, "positionsnummer": { "$ref": "#/components/schemas/positionsnummer", "x-edifact-segment": [ "SG14.CNI" ] } }, "required": [ "auftragsstatus", "fertigstellungsdatum", "lokationsId", "positionsnummer" ], "type": "object" }, "Sparte": { "description": "Sparte", "enum": [ "STROM", "GAS", "FERNWAERME", "NAHWAERME", "WASSER", "ABWASSER" ], "title": "Sparte", "type": "string" }, "Statusobjekt": { "description": "Statusobjekt", "enum": [ "MSBWECHSEL", "UMBAUMELO", "ERSTEINBAUIMS", "ERSTEINBAUMME", "GERAET", "ANGEBOTANFRAGE", "STATUSBESTELLUNG", "LIEFERSCHEIN", "SPERREN", "ENTSPERREN", "PRIVILEGIERUNG_NACH_ENFG", "VERAENDERUNGSSTATUS_DER_DATEN", "TURNUSAUSLESUNG", "PRUEFSTATUS_ANTWORT_SUMMENZEITREIHEN", "ABWEISUNG_SUMMENZEITREIHE", "PRUEFSTATUS_SUMMENZEITREIHE", "DATENSTATUS_SUMMENZEITREIHE", "ABWEISUNG_STATUSMELDUNG_AENDERUNG", "AUSFALLARBEIT", "FAHRPLANANTEIL", "GEGENVORSCHLAG_AUSFALLARBEIT", "GEGENVORSCHLAG_FAHRPLANANTEIL" ], "title": "Statusobjekt", "type": "string" }, "allgemeineInformationenText": { "description": "Allgemeine Informationen", "type": "string" }, "antwortstatus": { "description": "Antwortstatus / STS+E01", "type": "string" }, "antwortstatusCodeliste": { "description": "Antwortstatus Codeliste / STS+E01", "type": "string" }, "auftragsstatus": { "$ref": "#/components/schemas/Auftragsstatus" }, "event_response_fail": { "description": "Fehlermeldung auf Prozessdaten API Aufruf | Error message on process data API call", "properties": { "errorCode": { "description": "Error identifier", "example": "400", "type": "string" }, "message": { "description": "Technische Meldung | Technische Meldung", "example": "Validation Failed", "type": "string" } }, "type": "object" }, "event_responses_success": { "description": "Erfolgsmeldung auf Prozessdaten API Aufruf | Success message on process data API call", "properties": { "businessKey": { "description": "Einzigartige Kennung des Geschäftsprozesses | Unique identifier of the business process", "format": "uuid", "type": "string" }, "message": { "description": "Nachricht mit Details zum ausgelösten Event | Message with details about the triggered event", "example": "received event XXXXXXXXXXXX with id at 2024-08-08T12:58:22Z and started process with businessKey 4c7170ed-3518-41ee-8582-39ab65b00107", "type": "string" } }, "required": [ "businessKey", "message" ], "type": "object" }, "fertigstellungsdatum": { "description": "fertigstellungsdatum", "format": "date-time", "type": "string" }, "lokationsId": { "description": "Für welche Markt- oder Messlokation gilt diese Anfrage.", "type": "string" }, "positionsnummer": { "description": "Positionsnummer", "type": "integer" }, "rollencodenummer": { "description": "Gibt die Codenummer der Marktrolle an.", "type": "string" }, "sendungsposition": { "description": "sendungsposition", "type": "integer" }, "sparte": { "$ref": "#/components/schemas/Sparte", "description": "Enthält Informationen über die Sparte" }, "statusObjekt": { "$ref": "#/components/schemas/Statusobjekt" } } } }