{
"openapi": "3.1.0",
"info": {
"title": "START_ANFRAGE_SPERRUNG (LF)",
"version": "202610",
"description": "Das Ereignis `START_ANFRAGE_SPERRUNG` 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_ANFRAGE_SPERRUNG"
}
],
"paths": {
"/inbound": {
"post": {
"deprecated": false,
"description": "Trigger-Event **START_ANFRAGE_SPERRUNG** der Marktrolle LF.\n\n**Startet diese Rollensichten** (2):\n\n- [Unterbrechung der Anschlussnutzung (Sperren) auf Anweisung des LF — LF (AWH Sperrprozesse Gas)](/prozessdoku/202610/LF/awh-sperrprozesse-gas-unterbrechung-der-anschlussnutzung-sperren-auf-anweisung-des-lf)\n- [Unterbrechung der Anschlussnutzung (Sperren) auf Anweisung des LF — LF (GPKE Teil 2)](/prozessdoku/202610/LF/GPKE-Teil2-unterbrechung-der-anschlussnutzung-sperren-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 104 Rumpfvarianten heraus, damit sie einzeln lesbar und ausprobierbar sind.\n\n",
"operationId": "trigger_LF_START_ANFRAGE_SPERRUNG",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LF_START_ANFRAGE_SPERRUNG"
}
}
}
},
"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_ANFRAGE_SPERRUNG (LF)",
"tags": [
"START_ANFRAGE_SPERRUNG"
],
"x-actual-endpoint": "POST /inbound",
"x-event-source": "event/202610/[LF]_START_ANFRAGE_SPERRUNG.yaml",
"x-handbuchsatz": true
}
}
},
"components": {
"securitySchemes": {
"bearer": {
"scheme": "bearer",
"type": "http"
}
},
"schemas": {
"LF_START_ANFRAGE_SPERRUNG": {
"properties": {
"stammdaten": {
"anyOf": [
{
"$ref": "#/components/schemas/PI_17115__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 — 17115.",
"examples": [
"17115"
]
},
"sparte": {
"$ref": "#/components/schemas/sparte"
}
},
"required": [
"absender",
"empfaenger",
"kategorie",
"sparte"
],
"type": "object"
},
"zusatzdaten": {
"properties": {
"eventname": {
"const": "START_ANFRAGE_SPERRUNG",
"default": "START_ANFRAGE_SPERRUNG",
"type": "string"
},
"prozessId": {
"type": "string"
}
},
"required": [
"prozessId",
"eventname"
],
"type": "object"
}
},
"required": [
"stammdaten",
"transaktionsdaten",
"zusatzdaten"
],
"type": "object"
},
"Landescode": {
"description": "Der ISO-Landescode als Enumeration",
"enum": [
"AC",
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AN",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"BU",
"BV",
"BW",
"BY",
"BZ",
"CA",
"CC",
"CD",
"CF",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CP",
"CR",
"CS",
"CU",
"CV",
"CW",
"CX",
"CY",
"CZ",
"DE",
"DG",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EA",
"EC",
"EE",
"EG",
"EH",
"ER",
"ES",
"ET",
"EU",
"FI",
"FJ",
"FK",
"FM",
"FO",
"FR",
"FX",
"GA",
"GB",
"GD",
"GE",
"GF",
"GG",
"GH",
"GI",
"GL",
"GM",
"GN",
"GP",
"GQ",
"GR",
"GS",
"GT",
"GU",
"GW",
"GY",
"HK",
"HM",
"HN",
"HR",
"HT",
"HU",
"IC",
"ID",
"IE",
"IL",
"IM",
"IN",
"IO",
"IQ",
"IR",
"IS",
"IT",
"JE",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KP",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MF",
"MG",
"MH",
"MK",
"ML",
"MM",
"MN",
"MO",
"MP",
"MQ",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NC",
"NE",
"NF",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NT",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PF",
"PG",
"PH",
"PK",
"PL",
"PM",
"PN",
"PR",
"PS",
"PT",
"PW",
"PY",
"QA",
"RE",
"RO",
"RS",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SF",
"SG",
"SH",
"SI",
"SJ",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"SS",
"ST",
"SU",
"SV",
"SX",
"SY",
"SZ",
"TA",
"TC",
"TD",
"TF",
"TG",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TP",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"UK",
"UM",
"US",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VI",
"VN",
"VU",
"WF",
"WS",
"XK",
"YE",
"YT",
"YU",
"ZA",
"ZM",
"ZR",
"ZW"
],
"title": "Landescode",
"type": "string"
},
"PI_17115__stammdaten": {
"properties": {
"ANFRAGE": {
"items": {
"$ref": "#/components/schemas/PI_17115__stammdaten__ANFRAGE"
},
"type": "array"
},
"AUFTRAG": {
"items": {
"$ref": "#/components/schemas/PI_17115__stammdaten__AUFTRAG"
},
"type": "array"
},
"SPERRAUFTRAG": {
"items": {
"$ref": "#/components/schemas/PI_17115__stammdaten__SPERRAUFTRAG"
},
"type": "array"
}
},
"required": [
"ANFRAGE"
],
"type": "object",
"title": "17115"
},
"PI_17115__stammdaten__ANFRAGE": {
"properties": {
"lokationsId": {
"$ref": "#/components/schemas/lokationsId",
"x-edifact-segment": [
"SG2.NAD+DP.LOC+172"
]
}
},
"required": [
"lokationsId"
],
"type": "object"
},
"PI_17115__stammdaten__AUFTRAG": {
"properties": {
"ausfuehrungsdatum": {
"$ref": "#/components/schemas/ausfuehrungsdatum",
"x-edifact-segment": [
"DTM+203"
]
},
"positionsdaten": {
"items": {
"$ref": "#/components/schemas/PI_17115__stammdaten__AUFTRAG__positionsdaten"
},
"type": "array"
},
"startdatum": {
"$ref": "#/components/schemas/startdatum",
"x-edifact-segment": [
"DTM+469"
]
}
},
"type": "object"
},
"PI_17115__stammdaten__AUFTRAG__positionsdaten": {
"properties": {
"allgemeineInformationen": {
"$ref": "#/components/schemas/PI_17115__stammdaten__AUFTRAG__positionsdaten__allgemeineInformationen"
}
},
"type": "object"
},
"PI_17115__stammdaten__AUFTRAG__positionsdaten__allgemeineInformationen": {
"properties": {
"info1": {
"$ref": "#/components/schemas/info1",
"x-edifact-segment": [
"SG29.LIN.FTX+ACB"
]
},
"info2": {
"$ref": "#/components/schemas/info2",
"x-edifact-segment": [
"SG29.LIN.FTX+ACB"
]
},
"info3": {
"$ref": "#/components/schemas/info3",
"x-edifact-segment": [
"SG29.LIN.FTX+ACB"
]
},
"info4": {
"$ref": "#/components/schemas/info4",
"x-edifact-segment": [
"SG29.LIN.FTX+ACB"
]
},
"info5": {
"$ref": "#/components/schemas/info5",
"x-edifact-segment": [
"SG29.LIN.FTX+ACB"
]
}
},
"type": "object"
},
"PI_17115__stammdaten__SPERRAUFTRAG": {
"properties": {
"treffpunkt": {
"$ref": "#/components/schemas/PI_17115__stammdaten__SPERRAUFTRAG__treffpunkt"
}
},
"type": "object"
},
"PI_17115__stammdaten__SPERRAUFTRAG__treffpunkt": {
"properties": {
"hausnummer": {
"$ref": "#/components/schemas/hausnummer",
"x-edifact-segment": [
"SG2.NAD+Z24"
]
},
"landescode": {
"$ref": "#/components/schemas/landescode",
"x-edifact-segment": [
"SG2.NAD+Z24"
]
},
"ort": {
"$ref": "#/components/schemas/ort",
"x-edifact-segment": [
"SG2.NAD+Z24"
]
},
"ortsteil": {
"$ref": "#/components/schemas/ortsteil",
"x-edifact-segment": [
"SG2.NAD+Z24"
]
},
"postfach": {
"$ref": "#/components/schemas/postfach",
"x-edifact-segment": [
"SG2.NAD+Z24"
]
},
"postleitzahl": {
"$ref": "#/components/schemas/postleitzahl",
"x-edifact-segment": [
"SG2.NAD+Z24"
]
},
"strasse": {
"$ref": "#/components/schemas/strasse",
"x-edifact-segment": [
"SG2.NAD+Z24"
]
},
"zusatzInformation": {
"$ref": "#/components/schemas/PI_17115__stammdaten__SPERRAUFTRAG__treffpunkt__zusatzInformation"
}
},
"type": "object"
},
"PI_17115__stammdaten__SPERRAUFTRAG__treffpunkt__zusatzInformation": {
"properties": {
"zusatz1": {
"$ref": "#/components/schemas/zusatz1",
"x-edifact-segment": [
"SG2.NAD+Z24"
]
},
"zusatz2": {
"$ref": "#/components/schemas/zusatz2",
"x-edifact-segment": [
"SG2.NAD+Z24"
]
},
"zusatz3": {
"$ref": "#/components/schemas/zusatz3",
"x-edifact-segment": [
"SG2.NAD+Z24"
]
},
"zusatz4": {
"$ref": "#/components/schemas/zusatz4",
"x-edifact-segment": [
"SG2.NAD+Z24"
]
},
"zusatz5": {
"$ref": "#/components/schemas/zusatz5",
"x-edifact-segment": [
"SG2.NAD+Z24"
]
}
},
"type": "object"
},
"Sparte": {
"description": "Sparte",
"enum": [
"STROM",
"GAS",
"FERNWAERME",
"NAHWAERME",
"WASSER",
"ABWASSER"
],
"title": "Sparte",
"type": "string"
},
"ausfuehrungsdatum": {
"description": "Das Ausführungsdatum beschreibt zu welchem Zeitpunkt ein Auftrag ausgeführt werden soll.",
"format": "date-time",
"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"
},
"hausnummer": {
"description": "Hausnummer und Ergänzung",
"type": "string"
},
"info1": {
"description": "Allgemeine Info 1",
"type": "string"
},
"info2": {
"description": "Allgemeine Info 2",
"type": "string"
},
"info3": {
"description": "Allgemeine Info 3",
"type": "string"
},
"info4": {
"description": "Allgemeine Info 4",
"type": "string"
},
"info5": {
"description": "Allgemeine Info 5",
"type": "string"
},
"kategorie": {
"description": "Qualifier aus dem Beginn der EDIFact Nachricht / BGM",
"type": "string"
},
"landescode": {
"$ref": "#/components/schemas/Landescode",
"description": "Landescode"
},
"lokationsId": {
"description": "Für welche Markt- oder Messlokation gilt diese Anfrage.",
"type": "string"
},
"ort": {
"description": "Ort",
"type": "string"
},
"ortsteil": {
"description": "Ortsteil",
"type": "string"
},
"postfach": {
"description": "Postfach",
"type": "string"
},
"postleitzahl": {
"description": "Postleitzahl",
"type": "string"
},
"rollencodenummer": {
"description": "Gibt die Codenummer der Marktrolle an.",
"type": "string"
},
"sparte": {
"$ref": "#/components/schemas/Sparte",
"description": "Enthält Informationen über die Sparte"
},
"startdatum": {
"description": "startdatum",
"format": "date-time",
"type": "string"
},
"strasse": {
"description": "Strasse",
"type": "string"
},
"zusatz1": {
"description": "Adresszusatz 1",
"type": "string"
},
"zusatz2": {
"description": "Adresszusatz 2",
"type": "string"
},
"zusatz3": {
"description": "Adresszusatz 3",
"type": "string"
},
"zusatz4": {
"description": "Adresszusatz 4",
"type": "string"
},
"zusatz5": {
"description": "Adresszusatz 5",
"type": "string"
}
}
}
}