{
"openapi": "3.1.0",
"info": {
"title": "START_BESTELLUNG_KONFIGURATION (LF)",
"version": "202610",
"description": "Das Ereignis `START_BESTELLUNG_KONFIGURATION` der Marktrolle LF 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_BESTELLUNG_KONFIGURATION"
}
],
"paths": {
"/inbound": {
"post": {
"deprecated": false,
"description": "Trigger-Event **START_BESTELLUNG_KONFIGURATION** der Marktrolle LF.\n\n**Startet diese Rollensichten** (1):\n\n- [Bestellung einer Konfiguration vom LF an MSB — LF](/prozessdoku/202610/LF/GPKE-Teil3-bestellung-einer-konfiguration-vom-lf-an-msb)\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_LF_START_BESTELLUNG_KONFIGURATION",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"examples": {
"START_BESTELLUNG_KONFIGURATION": {
"$ref": "#/components/examples/START_BESTELLUNG_KONFIGURATION"
}
},
"schema": {
"$ref": "#/components/schemas/LF_START_BESTELLUNG_KONFIGURATION"
}
}
}
},
"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_BESTELLUNG_KONFIGURATION (LF)",
"tags": [
"START_BESTELLUNG_KONFIGURATION"
],
"x-actual-endpoint": "POST /inbound",
"x-event-source": "event/202610/[LF]_START_BESTELLUNG_KONFIGURATION.yaml",
"x-handbuchsatz": true
}
}
},
"components": {
"securitySchemes": {
"bearer": {
"scheme": "bearer",
"type": "http"
}
},
"schemas": {
"AenderungsmoeglichkeitKonfiguration": {
"description": "AenderungsmoeglichkeitKonfiguration",
"enum": [
"ERFORDERLICH",
"NICHT_ERFORDERLICH"
],
"title": "AenderungsmoeglichkeitKonfiguration",
"type": "string"
},
"LF_START_BESTELLUNG_KONFIGURATION": {
"properties": {
"stammdaten": {
"anyOf": [
{
"$ref": "#/components/schemas/PI_17130__stammdaten"
}
]
},
"transaktionsdaten": {
"properties": {
"absender": {
"properties": {
"rollencodenummer": {
"$ref": "#/components/schemas/rollencodenummer"
}
},
"type": "object"
},
"empfaenger": {
"properties": {
"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 — 17130.",
"examples": [
"17130"
]
},
"sparte": {
"$ref": "#/components/schemas/sparte"
}
},
"required": [
"absender",
"empfaenger",
"kategorie",
"sparte"
],
"type": "object"
},
"zusatzdaten": {
"properties": {
"eventname": {
"const": "START_BESTELLUNG_KONFIGURATION",
"default": "START_BESTELLUNG_KONFIGURATION",
"type": "string"
},
"prozessId": {
"type": "string"
}
},
"required": [
"prozessId",
"eventname"
],
"type": "object"
}
},
"required": [
"stammdaten",
"transaktionsdaten",
"zusatzdaten"
],
"type": "object"
},
"PI_17130__stammdaten": {
"properties": {
"ANFRAGE": {
"items": {
"$ref": "#/components/schemas/PI_17130__stammdaten__ANFRAGE"
},
"type": "array"
},
"AUFTRAG": {
"items": {
"$ref": "#/components/schemas/PI_17130__stammdaten__AUFTRAG"
},
"type": "array"
},
"WERTE_NACH_TYP2": {
"items": {
"$ref": "#/components/schemas/PI_17130__stammdaten__WERTE_NACH_TYP2"
},
"type": "array"
}
},
"required": [
"ANFRAGE"
],
"type": "object",
"title": "17130"
},
"PI_17130__stammdaten__ANFRAGE": {
"properties": {
"lokationsId": {
"$ref": "#/components/schemas/lokationsId",
"x-edifact-segment": [
"SG2.NAD+DP.LOC+172"
]
}
},
"required": [
"lokationsId"
],
"type": "object"
},
"PI_17130__stammdaten__AUFTRAG": {
"properties": {
"ausfuehrungsdatum": {
"$ref": "#/components/schemas/ausfuehrungsdatum",
"x-edifact-segment": [
"DTM+203"
]
}
},
"type": "object"
},
"PI_17130__stammdaten__WERTE_NACH_TYP2": {
"properties": {
"aenderungsmoeglichkeitKonfiguration": {
"$ref": "#/components/schemas/aenderungsmoeglichkeitKonfiguration",
"x-edifact-segment": [
"SG29.LIN+Z68.SG30.CCI+Z54"
]
},
"aussteller": {
"$ref": "#/components/schemas/PI_17130__stammdaten__WERTE_NACH_TYP2__aussteller"
},
"messprodukt": {
"$ref": "#/components/schemas/messprodukt",
"x-edifact-segment": [
"SG29.LIN+Z67.PIA+5",
"SG29.LIN+Z68.PIA+5"
]
},
"schwellwerte": {
"items": {
"$ref": "#/components/schemas/PI_17130__stammdaten__WERTE_NACH_TYP2__schwellwerte"
},
"type": "array"
},
"zertifikatsNutzer": {
"$ref": "#/components/schemas/PI_17130__stammdaten__WERTE_NACH_TYP2__zertifikatsNutzer"
},
"zieladresse": {
"$ref": "#/components/schemas/PI_17130__stammdaten__WERTE_NACH_TYP2__zieladresse"
}
},
"type": "object"
},
"PI_17130__stammdaten__WERTE_NACH_TYP2__aussteller": {
"properties": {
"aussteller1": {
"$ref": "#/components/schemas/aussteller1",
"x-edifact-segment": [
"SG29.LIN+Z68.FTX+Z24"
]
},
"aussteller2": {
"$ref": "#/components/schemas/aussteller2",
"x-edifact-segment": [
"SG29.LIN+Z68.FTX+Z24"
]
},
"aussteller3": {
"$ref": "#/components/schemas/aussteller3",
"x-edifact-segment": [
"SG29.LIN+Z68.FTX+Z24"
]
},
"aussteller4": {
"$ref": "#/components/schemas/aussteller4",
"x-edifact-segment": [
"SG29.LIN+Z68.FTX+Z24"
]
},
"aussteller5": {
"$ref": "#/components/schemas/aussteller5",
"x-edifact-segment": [
"SG29.LIN+Z68.FTX+Z24"
]
}
},
"type": "object"
},
"PI_17130__stammdaten__WERTE_NACH_TYP2__schwellwerte": {
"properties": {
"konfigurationsprodukt": {
"$ref": "#/components/schemas/konfigurationsprodukt",
"x-edifact-segment": [
"SG29.LIN+Z68.SG30.CCI+Z60"
]
},
"obererSchwellwert": {
"$ref": "#/components/schemas/obererSchwellwert",
"x-edifact-segment": [
"SG29.LIN+Z68.SG30.CCI+Z60"
]
},
"untererSchwellwert": {
"$ref": "#/components/schemas/untererSchwellwert",
"x-edifact-segment": [
"SG29.LIN+Z68.SG30.CCI+Z60"
]
}
},
"type": "object"
},
"PI_17130__stammdaten__WERTE_NACH_TYP2__zertifikatsNutzer": {
"properties": {
"zertifikatsNutzer1": {
"$ref": "#/components/schemas/zertifikatsNutzer1",
"x-edifact-segment": [
"SG29.LIN+Z68.FTX+Z23"
]
},
"zertifikatsNutzer2": {
"$ref": "#/components/schemas/zertifikatsNutzer2",
"x-edifact-segment": [
"SG29.LIN+Z68.FTX+Z23"
]
},
"zertifikatsNutzer3": {
"$ref": "#/components/schemas/zertifikatsNutzer3",
"x-edifact-segment": [
"SG29.LIN+Z68.FTX+Z23"
]
},
"zertifikatsNutzer4": {
"$ref": "#/components/schemas/zertifikatsNutzer4",
"x-edifact-segment": [
"SG29.LIN+Z68.FTX+Z23"
]
},
"zertifikatsNutzer5": {
"$ref": "#/components/schemas/zertifikatsNutzer5",
"x-edifact-segment": [
"SG29.LIN+Z68.FTX+Z23"
]
}
},
"type": "object"
},
"PI_17130__stammdaten__WERTE_NACH_TYP2__zieladresse": {
"properties": {
"zieladresse1": {
"$ref": "#/components/schemas/zieladresse1",
"x-edifact-segment": [
"SG29.LIN+Z68.FTX+Z17"
]
},
"zieladresse2": {
"$ref": "#/components/schemas/zieladresse2",
"x-edifact-segment": [
"SG29.LIN+Z68.FTX+Z17"
]
},
"zieladresse3": {
"$ref": "#/components/schemas/zieladresse3",
"x-edifact-segment": [
"SG29.LIN+Z68.FTX+Z17"
]
},
"zieladresse4": {
"$ref": "#/components/schemas/zieladresse4",
"x-edifact-segment": [
"SG29.LIN+Z68.FTX+Z17"
]
},
"zieladresse5": {
"$ref": "#/components/schemas/zieladresse5",
"x-edifact-segment": [
"SG29.LIN+Z68.FTX+Z17"
]
}
},
"type": "object"
},
"Sparte": {
"description": "Sparte",
"enum": [
"STROM",
"GAS",
"FERNWAERME",
"NAHWAERME",
"WASSER",
"ABWASSER"
],
"title": "Sparte",
"type": "string"
},
"aenderungsmoeglichkeitKonfiguration": {
"$ref": "#/components/schemas/AenderungsmoeglichkeitKonfiguration"
},
"ausfuehrungsdatum": {
"description": "Das Ausführungsdatum beschreibt zu welchem Zeitpunkt ein Auftrag ausgeführt werden soll.",
"format": "date-time",
"type": "string"
},
"aussteller1": {
"description": "aussteller1",
"type": "string"
},
"aussteller2": {
"description": "aussteller2",
"type": "string"
},
"aussteller3": {
"description": "aussteller3",
"type": "string"
},
"aussteller4": {
"description": "aussteller4",
"type": "string"
},
"aussteller5": {
"description": "aussteller5",
"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"
},
"konfigurationsprodukt": {
"description": "konfigurationsprodukt",
"type": "string"
},
"lokationsId": {
"description": "Für welche Markt- oder Messlokation gilt diese Anfrage.",
"type": "string"
},
"messprodukt": {
"description": "messprodukt",
"type": "string"
},
"obererSchwellwert": {
"description": "obererSchwellwert",
"format": "float",
"type": "number"
},
"rollencodenummer": {
"description": "Gibt die Codenummer der Marktrolle an.",
"type": "string"
},
"sparte": {
"$ref": "#/components/schemas/Sparte",
"description": "Enthält Informationen über die Sparte"
},
"untererSchwellwert": {
"description": "untererSchwellwert",
"format": "float",
"type": "number"
},
"zertifikatsNutzer1": {
"description": "zertifikatsNutzer1",
"type": "string"
},
"zertifikatsNutzer2": {
"description": "zertifikatsNutzer2",
"type": "string"
},
"zertifikatsNutzer3": {
"description": "zertifikatsNutzer3",
"type": "string"
},
"zertifikatsNutzer4": {
"description": "zertifikatsNutzer4",
"type": "string"
},
"zertifikatsNutzer5": {
"description": "zertifikatsNutzer5",
"type": "string"
},
"zieladresse1": {
"description": "zieladresse1",
"type": "string"
},
"zieladresse2": {
"description": "zieladresse2",
"type": "string"
},
"zieladresse3": {
"description": "zieladresse3",
"type": "string"
},
"zieladresse4": {
"description": "zieladresse4",
"type": "string"
},
"zieladresse5": {
"description": "zieladresse5",
"type": "string"
}
},
"examples": {
"START_BESTELLUNG_KONFIGURATION": {
"summary": "START_BESTELLUNG_KONFIGURATION - Einrichtung der Konfigurationen aufgrund einer Zuordnung eines LF zu einer Marktlokation bzw. Tranche (NB/MSB)",
"value": {
"stammdaten": {
"MARKTLOKATION": [
{
"beteiligterMarktpartner": [
{
"boTyp": "MARKTTEILNEHMER",
"marktrolle": "UENB",
"rollencodenummer": "9900683000008",
"rollencodetyp": "BDEW",
"versionStruktur": "1"
},
{
"boTyp": "MARKTTEILNEHMER",
"marktrolle": "MSB",
"rollencodenummer": "9900683000008",
"rollencodetyp": "BDEW",
"versionStruktur": "1"
}
],
"boTyp": "MARKTLOKATION",
"energierichtung": "AUSSP",
"marktlokationsId": "50754496000",
"sparte": "STROM",
"versionStruktur": "1",
"zaehlwerke": [
{
"messprodukt": "9991000000044",
"verwendungszwecke": [
{
"marktrolle": "NB",
"zweck": [
{
"items": "NETZNUTZUNGSABRECHNUNG"
},
{
"items": "BILANZKREISABRECHNUNG"
},
{
"items": "MEHRMINDERMENGENABRECHNUNG"
}
]
},
{
"marktrolle": "LF",
"zweck": [
{
"items": "ENDKUNDENABRECHNUNG"
},
{
"items": "NETZNUTZUNGSABRECHNUNG"
},
{
"items": "BILANZKREISABRECHNUNG"
},
{
"items": "MEHRMINDERMENGENABRECHNUNG"
}
]
}
],
"zaehlzeiten": {
"zaehlzeitDefinition": "ETS"
}
}
]
}
]
},
"transaktionsdaten": {
"absender": {
"rollencodenummer": "9903526000002",
"rollencodetyp": "BDEW"
},
"ausfuehrungsdatum": "2025-10-31T23:00:00Z",
"beteiligterMarktpartner": {
"boTyp": "MARKTTEILNEHMER",
"geschaeftspartnerrolle": "LIEFERANT",
"rollencodenummer": "9900683000008",
"rollencodetyp": "BDEW",
"versionStruktur": "1"
},
"empfaenger": {
"rollencodenummer": "9900683000008",
"rollencodetyp": "BDEW"
},
"kategorie": "Z92",
"sparte": "STROM",
"transaktionsgrund": "Z67"
},
"zusatzdaten": {
"eventname": "START_BESTELLUNG_KONFIGURATION",
"prozessId": "00505688-E4A2-1EDF-A0C2-C81842E2515E"
}
}
}
}
}
}