{
"openapi": "3.1.0",
"info": {
"title": "START_STORNO_SE_AUFTRAG (LF)",
"version": "202604",
"description": "Das Ereignis `START_STORNO_SE_AUFTRAG` der Marktrolle LF als eigenständige Spezifikation, abgeleitet aus der Auslöser-API der Formatversion 202604. 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_STORNO_SE_AUFTRAG"
}
],
"paths": {
"/inbound": {
"post": {
"deprecated": false,
"description": "Trigger-Event **START_STORNO_SE_AUFTRAG** der Marktrolle LF.\n\n**Startet diese Rollensichten** (2):\n\n- [Stornieren der Unterbrechung und Wiederherstellung der Anschlussnutzung auf\nAnweisung des LF — LF](/prozessdoku/202604/LF/awh-sperrprozesse-gas-stornieren-der-unterbrechung-und-wiederherstellung-der-anschlussnutzung-auf-anweisung-des-lf)\n- [Stornieren der Unterbrechung und Wiederherstellung der Anschlussnutzung auf Anweisung des LF — LF](/prozessdoku/202604/LF/GPKE-Teil2-stornieren-der-unterbrechung-und-wiederherstellung-der-anschlussnutzung-auf-anweisung-des-lf)\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 105 Rumpfvarianten heraus, damit sie einzeln lesbar und ausprobierbar sind.\n\n",
"operationId": "trigger_LF_START_STORNO_SE_AUFTRAG",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LF_START_STORNO_SE_AUFTRAG"
}
}
}
},
"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_STORNO_SE_AUFTRAG (LF)",
"tags": [
"START_STORNO_SE_AUFTRAG"
],
"x-actual-endpoint": "POST /inbound",
"x-event-source": "event/202604/[LF]_START_STORNO_SE_AUFTRAG.yaml",
"x-handbuchsatz": true
}
}
},
"components": {
"securitySchemes": {
"bearer": {
"scheme": "bearer",
"type": "http"
}
},
"schemas": {
"Anfragekategorie": {
"description": "Anfragekategorie",
"enum": [
"PROZESSDATENBERICHT",
"GERAETEUEBERNAHME",
"WEITERVERPFLICHTUNG_BETRIEB_MELO",
"AENDERUNG_MELO",
"STAMMDATEN_MALO_ODER_MELO",
"BILANZIERTE_MENGE_MEHR_MINDER_MENGEN",
"ALLOKATIONSLISTE_MEHR_MINDER_MENGEN",
"ENERGIEMENGE_UND_LEISTUNGSMAXIMUM",
"ABRECHNUNG_MESSSTELLENBETRIEB_MSB_AN_LF",
"AENDERUNG_PROGNOSEGRUNDLAGE_GERAETEKONFIGURATION",
"AENDERUNG_GERAETEKONFIGURATION",
"REKLAMATION_VON_WERTEN",
"LASTGANG_MALO_TRANCHE",
"SPERRUNG",
"ENTSPERRUNG",
"REKLAMATION_ZAEHLZEITDEFINITION",
"ZEITREIHEN_IM_RAHMEN_BILANZKREISABRECHNUNG",
"GERAETEWECHSELABSICHT",
"AENDERUNG_KONZESSIONSABGABE",
"AENDERUNG_ZAEHLZEITDEFINITION",
"UEBERMITTLUNG_WERTE_AN_ESA",
"AENDERUNG",
"BILANZKREISZUORDNUNGSLISTE",
"CLEARINGLISTE",
"NORMIERTES_PROFIL_PROFILSCHAR",
"REDISPATCH_EINZELZEITREIHE_AUSFALLARBEIT",
"REKLAMATION_PROFIL_PROFILSCHAR",
"STAMMDATEN_MALO",
"STAMMDATEN_MELO",
"STAMMDATEN_TRANCHE",
"BEENDIGUNG_EINER_KONFIGURATION",
"BESTELLUNG_EINER_KONFIGURATION",
"BESTELLUNG_EINES_ANGEBOTS_EINER_KONFIGURATION",
"REKLAMATION_EINER_KONFIGURATION",
"BESTELLUNG_AENDERUNG_NETZENTGELTE_NETZORIENTIERTER_STEUERUNGSMOEGLICHKEIT",
"AENDERUNG_DER_TECHNIK_DER_LOKATION",
"AENDERUNG_INDIVIDUELLER_KONFIGURATION",
"BESTELLUNG_AENDERUNG_ABRECHNUNGSDATEN",
"EINRICHTUNG_KONFIGURATION_AUFGRUND_ZUORDNUNG_LF",
"REKLAMATION_DEFINITION",
"BESTELLUNG_ANGEBOT_AENDERUNG_TECHNIK_LOKATION"
],
"title": "Anfragekategorie",
"type": "string"
},
"LF_START_STORNO_SE_AUFTRAG": {
"properties": {
"stammdaten": {
"anyOf": [
{
"$ref": "#/components/schemas/PI_39000__stammdaten"
}
]
},
"transaktionsdaten": {
"properties": {
"absender": {
"properties": {
"rollencodenummer": {
"$ref": "#/components/schemas/rollencodenummer"
}
},
"type": "object"
},
"auftragsReferenz": {
"$ref": "#/components/schemas/auftragsReferenz"
},
"empfaenger": {
"properties": {
"marktrolle": {
"$ref": "#/components/schemas/marktrolle"
},
"rollencodenummer": {
"$ref": "#/components/schemas/rollencodenummer"
}
},
"type": "object"
},
"kategorie": {
"$ref": "#/components/schemas/kategorie"
},
"pruefidentifikator": {
"description": "Wird dynamisch im Event-Prozess ermittelt. Ein vom Sender mitgegebener Wert wird ignoriert. Im Topic mögliche Prüfis — 39000.",
"examples": [
"39000"
]
},
"sparte": {
"$ref": "#/components/schemas/sparte"
}
},
"required": [
"absender",
"auftragsReferenz",
"empfaenger",
"kategorie",
"sparte"
],
"type": "object"
},
"zusatzdaten": {
"properties": {
"eventname": {
"const": "START_STORNO_SE_AUFTRAG",
"default": "START_STORNO_SE_AUFTRAG",
"type": "string"
},
"prozessId": {
"type": "string"
}
},
"required": [
"prozessId",
"eventname"
],
"type": "object"
}
},
"required": [
"stammdaten",
"transaktionsdaten",
"zusatzdaten"
],
"type": "object"
},
"Marktrolle": {
"description": "Diese Rollen kann ein Marktteilnehmer einnehmen",
"enum": [
"NB",
"LF",
"MSB",
"MSBA",
"GMSB",
"MDL",
"DL",
"BKV",
"BKO",
"UENB",
"KUNDE-SELBST-NN",
"MGV",
"EIV",
"RB",
"KUNDE",
"INTERESSENT",
"KN",
"UBA",
"BIKO",
"ESA"
],
"title": "Marktrolle",
"type": "string"
},
"PI_39000__stammdaten": {
"properties": {
"ANFRAGE": {
"items": {
"$ref": "#/components/schemas/PI_39000__stammdaten__ANFRAGE"
},
"type": "array"
}
},
"required": [
"ANFRAGE"
],
"type": "object",
"title": "39000"
},
"PI_39000__stammdaten__ANFRAGE": {
"properties": {
"anfragekategorie": {
"$ref": "#/components/schemas/anfragekategorie",
"x-edifact-segment": [
"BGM"
]
}
},
"required": [
"anfragekategorie"
],
"type": "object"
},
"Sparte": {
"description": "Sparte",
"enum": [
"STROM",
"GAS",
"FERNWAERME",
"NAHWAERME",
"WASSER",
"ABWASSER"
],
"title": "Sparte",
"type": "string"
},
"anfragekategorie": {
"$ref": "#/components/schemas/Anfragekategorie",
"description": "Kategorie der Anfrage (ORDERS ORDRSP BGM 1001)"
},
"auftragsReferenz": {
"description": "Auftragsnummer 'Einkauf' / RFF+ON",
"type": "string"
},
"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"
},
"kategorie": {
"description": "Qualifier aus dem Beginn der EDIFact Nachricht / BGM",
"type": "string"
},
"marktrolle": {
"$ref": "#/components/schemas/Marktrolle",
"description": "Gibt im Klartext die Bezeichnung der Marktrolle an."
},
"rollencodenummer": {
"description": "Gibt die Codenummer der Marktrolle an.",
"type": "string"
},
"sparte": {
"$ref": "#/components/schemas/Sparte",
"description": "Enthält Informationen über die Sparte"
}
}
}
}