{
"openapi": "3.1.0",
"info": {
"title": "START_KUENDIGUNG_MSB (MSB)",
"version": "202610",
"description": "The event `START_KUENDIGUNG_MSB` of the market role MSB as a standalone specification, derived from the trigger API of format version 202610. Exactly one path: `POST /inbound`; the event is derived from `zusatzdaten.eventname` in the body."
},
"servers": [
{
"description": "Fake Env",
"url": "https://api.macoapp.de"
}
],
"tags": [
{
"name": "START_KUENDIGUNG_MSB"
}
],
"paths": {
"/inbound": {
"post": {
"deprecated": false,
"description": "Trigger-Event **START_KUENDIGUNG_MSB** der Marktrolle MSB.\n\n**Startet diese Rollensichten** (2):\n\n- [Kündigung Messstellenbetrieb — MSBN (AWH WiM Gas 2.0)](/prozessdoku/202610/MSB--MSBN/awh-wim-gas-2-0-kundigung-messstellenbetrieb)\n- [Kündigung Messstellenbetrieb — MSBN (WiM Strom Teil 1)](/prozessdoku/202610/MSB--MSBN/WiM-Teil1-kuendigung-messstellenbetrieb)\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_MSB_START_KUENDIGUNG_MSB",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MSB_START_KUENDIGUNG_MSB"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_responses_success"
}
}
},
"description": "Success | Success"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_response_fail"
}
}
},
"description": "Error | Fail"
}
},
"security": [
{
"bearer": []
}
],
"summary": "START_KUENDIGUNG_MSB (MSB)",
"tags": [
"START_KUENDIGUNG_MSB"
],
"x-actual-endpoint": "POST /inbound",
"x-event-source": "event/202610/[MSB]_START_KUENDIGUNG_MSB.yaml",
"x-handbuchsatz": true
}
}
},
"components": {
"securitySchemes": {
"bearer": {
"scheme": "bearer",
"type": "http"
}
},
"schemas": {
"Datenqualitaet": {
"description": "Data quality",
"enum": [
"ERWARTETE_DATEN",
"IM_SYSTEM_VORHANDENE_DATEN",
"INFORMATIVE_DATEN",
"GUELTIGE_DATEN",
"KEINE_DATEN",
"IM_SYSTEM_KEINE_DATEN_VORHANDEN",
"KEINE_DATEN_ERWARTET",
"DIFFERENZ_DATEN",
"DIFFERENZ_ERWARTETE_DATEN",
"DIFFERENZ_IM_SYSTEM_VORHANDENE_DATEN"
],
"title": "Data quality",
"type": "string"
},
"Geschaeftspartnerrolle": {
"description": "Geschaeftspartnerrolle",
"enum": [
"KUNDE",
"LIEFERANT",
"DIENSTLEISTER",
"INTERESSENT",
"MARKTPARTNER",
"EIGENTUEMER",
"HAUSVERWALTER",
"KORRESPONDENZEMPFAENGER",
"ABLESEKARTENEMPFAENGER"
],
"title": "Geschaeftspartnerrolle",
"type": "string"
},
"Landescode": {
"description": "The ISO country code as an 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": "Country code",
"type": "string"
},
"MSB_START_KUENDIGUNG_MSB": {
"properties": {
"stammdaten": {
"anyOf": [
{
"$ref": "#/components/schemas/PI_44039__stammdaten"
},
{
"$ref": "#/components/schemas/PI_55039__stammdaten"
}
]
},
"transaktionsdaten": {
"properties": {
"pruefidentifikator": {
"description": "Determined dynamically in the event process (basis for the decision: sparte). A value supplied by the sender is ignored. Check identifiers possible in the topic — 44039, 55039.",
"examples": [
"44039",
"55039"
]
}
},
"type": "object"
},
"zusatzdaten": {
"properties": {
"eventname": {
"const": "START_KUENDIGUNG_MSB",
"default": "START_KUENDIGUNG_MSB",
"type": "string"
},
"prozessId": {
"type": "string"
}
},
"required": [
"prozessId",
"eventname"
],
"type": "object"
}
},
"required": [
"stammdaten",
"transaktionsdaten",
"zusatzdaten"
],
"type": "object",
"x-pending-dmn": {
"reason": "Kein Eintrag in S_EVENT_VARIABLEN.dmn — der Prozess setzt für dieses Event keine Variablen. Der Pflichtsatz von transaktionsdaten ist damit nicht bestimmbar und bleibt offen, bis die DMN-Zeile existiert."
},
"x-unresolved-routing": [
{
"conditions": [
"${sparte==\"GAS\"}",
"${sparte==\"STROM\"}"
],
"discriminates": true,
"selects-pruefis": [
"44039",
"55039"
],
"variable": "sparte"
}
]
},
"PI_44039__stammdaten": {
"properties": {
"MESSLOKATION": {
"items": {
"$ref": "#/components/schemas/PI_44039__stammdaten__MESSLOKATION"
},
"type": "array"
},
"MESSSTELLENBETRIEBSVERTRAG": {
"items": {
"$ref": "#/components/schemas/PI_44039__stammdaten__MESSSTELLENBETRIEBSVERTRAG"
},
"type": "array"
},
"NETZNUTZUNGSVERTRAG": {
"items": {
"$ref": "#/components/schemas/PI_44039__stammdaten__NETZNUTZUNGSVERTRAG"
},
"type": "array"
},
"ZAEHLER": {
"items": {
"$ref": "#/components/schemas/PI_44039__stammdaten__ZAEHLER"
},
"type": "array"
}
},
"required": [
"MESSSTELLENBETRIEBSVERTRAG"
],
"type": "object",
"title": "44039"
},
"PI_44039__stammdaten__MESSLOKATION": {
"properties": {
"messadresse": {
"$ref": "#/components/schemas/PI_44039__stammdaten__MESSLOKATION__messadresse"
},
"messlokationsId": {
"$ref": "#/components/schemas/messlokationsId",
"x-edifact-segment": [
"SG4.IDE+24.SG5.LOC+172"
]
}
},
"type": "object"
},
"PI_44039__stammdaten__MESSLOKATION__messadresse": {
"properties": {
"hausnummer": {
"$ref": "#/components/schemas/hausnummer",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"landescode": {
"$ref": "#/components/schemas/landescode",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"ort": {
"$ref": "#/components/schemas/ort",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"ortsteil": {
"$ref": "#/components/schemas/ortsteil",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"postfach": {
"$ref": "#/components/schemas/postfach",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"postleitzahl": {
"$ref": "#/components/schemas/postleitzahl",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"strasse": {
"$ref": "#/components/schemas/strasse",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"zusatzInformation": {
"$ref": "#/components/schemas/PI_44039__stammdaten__MESSLOKATION__messadresse__zusatzInformation"
}
},
"type": "object"
},
"PI_44039__stammdaten__MESSLOKATION__messadresse__zusatzInformation": {
"properties": {
"zusatz1": {
"$ref": "#/components/schemas/zusatz1",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"zusatz2": {
"$ref": "#/components/schemas/zusatz2",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"zusatz3": {
"$ref": "#/components/schemas/zusatz3",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"zusatz4": {
"$ref": "#/components/schemas/zusatz4",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"zusatz5": {
"$ref": "#/components/schemas/zusatz5",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
}
},
"type": "object"
},
"PI_44039__stammdaten__MESSSTELLENBETRIEBSVERTRAG": {
"properties": {
"vertragspartner2": {
"items": {
"$ref": "#/components/schemas/PI_44039__stammdaten__MESSSTELLENBETRIEBSVERTRAG__vertragspartner2"
},
"type": "array"
}
},
"required": [
"vertragspartner2"
],
"type": "object"
},
"PI_44039__stammdaten__MESSSTELLENBETRIEBSVERTRAG__vertragspartner2": {
"properties": {
"anrede": {
"$ref": "#/components/schemas/anrede",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z07"
]
},
"gewerbekennzeichnung": {
"$ref": "#/components/schemas/gewerbekennzeichnung",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z07"
]
},
"name1": {
"$ref": "#/components/schemas/name1",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z07"
]
},
"name2": {
"$ref": "#/components/schemas/name2",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z07"
]
},
"name3": {
"$ref": "#/components/schemas/name3",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z07"
]
},
"name4": {
"$ref": "#/components/schemas/name4",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z07"
]
}
},
"required": [
"name1"
],
"type": "object"
},
"PI_44039__stammdaten__NETZNUTZUNGSVERTRAG": {
"properties": {
"vertragsende": {
"$ref": "#/components/schemas/vertragsende",
"x-edifact-segment": [
"SG4.IDE+24.DTM+93"
]
}
},
"type": "object"
},
"PI_44039__stammdaten__ZAEHLER": {
"properties": {
"zaehlernummer": {
"$ref": "#/components/schemas/zaehlernummer",
"x-edifact-segment": [
"SG4.IDE+24.SG8.SEQ+Z03.SG10.CCI+++E13.CAV+Z30"
]
}
},
"type": "object"
},
"PI_55039__stammdaten": {
"properties": {
"MARKTLOKATION": {
"items": {
"$ref": "#/components/schemas/PI_55039__stammdaten__MARKTLOKATION"
},
"type": "array"
},
"MESSLOKATION": {
"items": {
"$ref": "#/components/schemas/PI_55039__stammdaten__MESSLOKATION"
},
"type": "array"
},
"MESSSTELLENBETRIEBSVERTRAG": {
"items": {
"$ref": "#/components/schemas/PI_55039__stammdaten__MESSSTELLENBETRIEBSVERTRAG"
},
"type": "array"
},
"NETZNUTZUNGSVERTRAG": {
"items": {
"$ref": "#/components/schemas/PI_55039__stammdaten__NETZNUTZUNGSVERTRAG"
},
"type": "array"
},
"ZAEHLER": {
"items": {
"$ref": "#/components/schemas/PI_55039__stammdaten__ZAEHLER"
},
"type": "array"
}
},
"required": [
"MESSSTELLENBETRIEBSVERTRAG"
],
"type": "object",
"title": "55039"
},
"PI_55039__stammdaten__MARKTLOKATION": {
"properties": {
"marktlokationsId": {
"$ref": "#/components/schemas/marktlokationsId",
"x-edifact-segment": [
"SG4.IDE+24.SG5.LOC+Z16"
]
}
},
"type": "object"
},
"PI_55039__stammdaten__MESSLOKATION": {
"properties": {
"datenqualitaet": {
"$ref": "#/components/schemas/datenqualitaet",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"messadresse": {
"$ref": "#/components/schemas/PI_55039__stammdaten__MESSLOKATION__messadresse"
},
"messlokationsId": {
"$ref": "#/components/schemas/messlokationsId",
"x-edifact-segment": [
"SG4.IDE+24.SG5.LOC+Z17"
]
}
},
"type": "object"
},
"PI_55039__stammdaten__MESSLOKATION__messadresse": {
"properties": {
"hausnummer": {
"$ref": "#/components/schemas/hausnummer",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"landescode": {
"$ref": "#/components/schemas/landescode",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"ort": {
"$ref": "#/components/schemas/ort",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"ortsteil": {
"$ref": "#/components/schemas/ortsteil",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"postfach": {
"$ref": "#/components/schemas/postfach",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"postleitzahl": {
"$ref": "#/components/schemas/postleitzahl",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"strasse": {
"$ref": "#/components/schemas/strasse",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"zusatzInformation": {
"$ref": "#/components/schemas/PI_55039__stammdaten__MESSLOKATION__messadresse__zusatzInformation"
}
},
"type": "object"
},
"PI_55039__stammdaten__MESSLOKATION__messadresse__zusatzInformation": {
"properties": {
"zusatz1": {
"$ref": "#/components/schemas/zusatz1",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"zusatz2": {
"$ref": "#/components/schemas/zusatz2",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"zusatz3": {
"$ref": "#/components/schemas/zusatz3",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"zusatz4": {
"$ref": "#/components/schemas/zusatz4",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
},
"zusatz5": {
"$ref": "#/components/schemas/zusatz5",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z03"
]
}
},
"type": "object"
},
"PI_55039__stammdaten__MESSSTELLENBETRIEBSVERTRAG": {
"properties": {
"vertragspartner2": {
"items": {
"$ref": "#/components/schemas/PI_55039__stammdaten__MESSSTELLENBETRIEBSVERTRAG__vertragspartner2"
},
"type": "array"
}
},
"required": [
"vertragspartner2"
],
"type": "object"
},
"PI_55039__stammdaten__MESSSTELLENBETRIEBSVERTRAG__vertragspartner2": {
"properties": {
"anrede": {
"$ref": "#/components/schemas/anrede",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z07"
]
},
"geschaeftspartnerrolle": {
"$ref": "#/components/schemas/geschaeftspartnerrolle",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z07"
]
},
"name1": {
"$ref": "#/components/schemas/name1",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z07"
]
},
"name2": {
"$ref": "#/components/schemas/name2",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z07"
]
},
"name3": {
"$ref": "#/components/schemas/name3",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z07"
]
},
"name4": {
"$ref": "#/components/schemas/name4",
"x-edifact-segment": [
"SG4.IDE+24.SG12.NAD+Z07"
]
}
},
"required": [
"name1"
],
"type": "object"
},
"PI_55039__stammdaten__NETZNUTZUNGSVERTRAG": {
"properties": {
"vertragsende": {
"$ref": "#/components/schemas/vertragsende",
"x-edifact-segment": [
"SG4.IDE+24.DTM+93"
]
}
},
"type": "object"
},
"PI_55039__stammdaten__ZAEHLER": {
"properties": {
"zaehlernummer": {
"$ref": "#/components/schemas/zaehlernummer",
"x-edifact-segment": [
"SG4.IDE+24.SG8.SEQ+Z03.SG10.CCI+++E13.CAV+Z30"
]
}
},
"type": "object"
},
"anrede": {
"description": "The form of address for the GePa, e.g. Mr.",
"type": "string"
},
"datenqualitaet": {
"$ref": "#/components/schemas/Datenqualitaet"
},
"event_response_fail": {
"description": "Error message on process data API call | Error message on process data API call",
"properties": {
"errorCode": {
"description": "Error identifier",
"example": "400",
"type": "string"
},
"message": {
"description": "Technical message | Technical message",
"example": "Validation Failed",
"type": "string"
}
},
"type": "object"
},
"event_responses_success": {
"description": "Success message on process data API call | Success message on process data API call",
"properties": {
"businessKey": {
"description": "Unique identifier of the business process | Unique identifier of the business process",
"format": "uuid",
"type": "string"
},
"message": {
"description": "Message with details about the triggered 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"
},
"geschaeftspartnerrolle": {
"description": "Role held by the business partner (e.g. prospect, customer).",
"items": {
"$ref": "#/components/schemas/Geschaeftspartnerrolle"
},
"nullable": true,
"type": "array"
},
"gewerbekennzeichnung": {
"description": "Indicates whether this is a commercial business/company (gewerbeKennzeichnung = true)\nor a private individual. (gewerbeKennzeichnung = false)",
"type": "boolean"
},
"hausnummer": {
"description": "House number and supplement",
"type": "string"
},
"landescode": {
"$ref": "#/components/schemas/Landescode",
"description": "Country code"
},
"marktlokationsId": {
"description": "Identification number of a market location at which energy is either\nconsumed or generated",
"type": "string"
},
"messlokationsId": {
"description": "The metering location identification. This is the former metering point identifier,\ne.g. DE 47108151234567",
"type": "string"
},
"name1": {
"description": "First part of the name. Here the company name or, for private individuals,\nfor example the surname can be entered. Examples: Yellow Strom GmbH\nor Hagen",
"type": "string"
},
"name2": {
"description": "Second part of the name. This can hold an extension to the company name or,\nfor private individuals, the first name, for example. Examples:\nSouth region or Nina",
"type": "string"
},
"name3": {
"description": "Third part of the name. Here further additions to the company name or,\nfor private individuals, additions to the name can be shown. Examples: and Africa\nor singer",
"type": "string"
},
"name4": {
"description": "name4",
"type": "string"
},
"ort": {
"description": "City",
"type": "string"
},
"ortsteil": {
"description": "District",
"type": "string"
},
"postfach": {
"description": "PO box",
"type": "string"
},
"postleitzahl": {
"description": "Postal code",
"type": "string"
},
"strasse": {
"description": "Street",
"type": "string"
},
"vertragsende": {
"description": "Contract end date / DTM+93",
"format": "date-time",
"type": "string"
},
"zaehlernummer": {
"description": "Numbering of the meter, assigned by the metering point operator",
"type": "string"
},
"zusatz1": {
"description": "Address supplement 1",
"type": "string"
},
"zusatz2": {
"description": "Address supplement 2",
"type": "string"
},
"zusatz3": {
"description": "Address supplement 3",
"type": "string"
},
"zusatz4": {
"description": "Address supplement 4",
"type": "string"
},
"zusatz5": {
"description": "Address supplement 5",
"type": "string"
}
}
}
}