{
"openapi": "3.1.0",
"info": {
"title": "START_REKLAMATION_DEFINITION (MSB)",
"version": "202604",
"description": "Das Ereignis `START_REKLAMATION_DEFINITION` der Marktrolle MSB 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_REKLAMATION_DEFINITION"
}
],
"paths": {
"/inbound": {
"post": {
"deprecated": false,
"description": "Trigger-Event **START_REKLAMATION_DEFINITION** der Marktrolle MSB.\n\n**Startet diese Rollensichten** (4):\n\n- [Reklamation der Übersicht der Definitionen des LF vom MSB an LF — MSB](/prozessdoku/202604/MSB/GPKE-Teil3-reklamation-der-uebersicht-der-definitionen-des-lf-vom-msb-an-lf)\n- [Reklamation der Übersicht der Definitionen des NB vom MSB an NB — MSB](/prozessdoku/202604/MSB/GPKE-Teil3-reklamation-der-uebersicht-der-definitionen-des-nb-vom-msb-an-nb)\n- [Reklamation einer Definition des LF vom MSB an LF — MSB](/prozessdoku/202604/MSB/GPKE-Teil3-reklamation-einer-definition-des-lf-vom-msb-an-lf)\n- [Reklamation einer Definition des NB vom MSB an NB — MSB](/prozessdoku/202604/MSB/GPKE-Teil3-reklamation-einer-definition-des-nb-vom-msb-an-nb)\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_MSB_START_REKLAMATION_DEFINITION",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MSB_START_REKLAMATION_DEFINITION"
}
}
}
},
"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_REKLAMATION_DEFINITION (MSB)",
"tags": [
"START_REKLAMATION_DEFINITION"
],
"x-actual-endpoint": "POST /inbound",
"x-event-source": "event/202604/[MSB]_START_REKLAMATION_DEFINITION.yaml",
"x-handbuchsatz": true
}
}
},
"components": {
"securitySchemes": {
"bearer": {
"scheme": "bearer",
"type": "http"
}
},
"schemas": {
"DefinitionsTyp": {
"description": "DefinitionsTyp",
"enum": [
"ZAEHLZEIT",
"SCHALTZEIT",
"LEISTUNGSKURVEN"
],
"title": "DefinitionsTyp",
"type": "string"
},
"MSB_START_REKLAMATION_DEFINITION": {
"properties": {
"stammdaten": {
"anyOf": [
{
"$ref": "#/components/schemas/PI_17122__stammdaten"
}
]
},
"transaktionsdaten": {
"properties": {
"absender": {
"properties": {
"marktrolle": {
"$ref": "#/components/schemas/marktrolle"
},
"rollencodenummer": {
"$ref": "#/components/schemas/rollencodenummer"
}
},
"type": "object"
},
"anfragereferenznummer": {
"$ref": "#/components/schemas/anfragereferenznummer"
},
"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 — 17122.",
"examples": [
"17122"
]
},
"sparte": {
"$ref": "#/components/schemas/sparte"
}
},
"required": [
"absender",
"anfragereferenznummer",
"empfaenger",
"kategorie",
"sparte"
],
"type": "object"
},
"zusatzdaten": {
"properties": {
"eventname": {
"const": "START_REKLAMATION_DEFINITION",
"default": "START_REKLAMATION_DEFINITION",
"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_17122__stammdaten": {
"properties": {
"AUFTRAG": {
"items": {
"$ref": "#/components/schemas/PI_17122__stammdaten__AUFTRAG"
},
"type": "array"
},
"LEISTUNGSKURVENDEFINITION": {
"items": {
"$ref": "#/components/schemas/PI_17122__stammdaten__LEISTUNGSKURVENDEFINITION"
},
"type": "array"
},
"REKLAMATION": {
"items": {
"$ref": "#/components/schemas/PI_17122__stammdaten__REKLAMATION"
},
"type": "array"
},
"SCHALTZEITDEFINITION": {
"items": {
"$ref": "#/components/schemas/PI_17122__stammdaten__SCHALTZEITDEFINITION"
},
"type": "array"
},
"ZAEHLZEITDEFINITION": {
"items": {
"$ref": "#/components/schemas/PI_17122__stammdaten__ZAEHLZEITDEFINITION"
},
"type": "array"
}
},
"required": [
"AUFTRAG",
"REKLAMATION"
],
"type": "object",
"title": "17122"
},
"PI_17122__stammdaten__AUFTRAG": {
"properties": {
"positionsdaten": {
"items": {
"$ref": "#/components/schemas/PI_17122__stammdaten__AUFTRAG__positionsdaten"
},
"type": "array"
}
},
"required": [
"positionsdaten"
],
"type": "object"
},
"PI_17122__stammdaten__AUFTRAG__positionsdaten": {
"properties": {
"definitionsTyp": {
"$ref": "#/components/schemas/definitionsTyp",
"x-edifact-segment": [
"SG29.LIN"
]
},
"positionsnummer": {
"$ref": "#/components/schemas/positionsnummer",
"x-edifact-segment": [
"SG29.LIN"
]
}
},
"required": [
"definitionsTyp",
"positionsnummer"
],
"type": "object"
},
"PI_17122__stammdaten__LEISTUNGSKURVENDEFINITION": {
"properties": {
"leistungskurven": {
"items": {
"$ref": "#/components/schemas/PI_17122__stammdaten__LEISTUNGSKURVENDEFINITION__leistungskurven"
},
"type": "array"
}
},
"type": "object"
},
"PI_17122__stammdaten__LEISTUNGSKURVENDEFINITION__leistungskurven": {
"properties": {
"code": {
"$ref": "#/components/schemas/code",
"x-edifact-segment": [
"SG29.LIN.SG30.CCI+Z52"
]
}
},
"type": "object"
},
"PI_17122__stammdaten__REKLAMATION": {
"properties": {
"reklamationsgrund": {
"$ref": "#/components/schemas/reklamationsgrund",
"x-edifact-segment": [
"SG29.LIN.FTX+[Z07|Z08|Z09|Z10]"
]
},
"reklamationsgrundBemerkung": {
"$ref": "#/components/schemas/PI_17122__stammdaten__REKLAMATION__reklamationsgrundBemerkung"
}
},
"required": [
"reklamationsgrund"
],
"type": "object"
},
"PI_17122__stammdaten__REKLAMATION__reklamationsgrundBemerkung": {
"properties": {
"bemerkung1": {
"$ref": "#/components/schemas/bemerkung1",
"x-edifact-segment": [
"SG29.LIN.FTX+[Z07|Z08|Z09|Z10]"
]
},
"bemerkung2": {
"$ref": "#/components/schemas/bemerkung2",
"x-edifact-segment": [
"SG29.LIN.FTX+[Z07|Z08|Z09|Z10]"
]
},
"bemerkung3": {
"$ref": "#/components/schemas/bemerkung3",
"x-edifact-segment": [
"SG29.LIN.FTX+[Z07|Z08|Z09|Z10]"
]
},
"bemerkung4": {
"$ref": "#/components/schemas/bemerkung4",
"x-edifact-segment": [
"SG29.LIN.FTX+[Z07|Z08|Z09|Z10]"
]
},
"bemerkung5": {
"$ref": "#/components/schemas/bemerkung5",
"x-edifact-segment": [
"SG29.LIN.FTX+[Z07|Z08|Z09|Z10]"
]
}
},
"type": "object"
},
"PI_17122__stammdaten__SCHALTZEITDEFINITION": {
"properties": {
"schaltzeiten": {
"items": {
"$ref": "#/components/schemas/PI_17122__stammdaten__SCHALTZEITDEFINITION__schaltzeiten"
},
"type": "array"
}
},
"type": "object"
},
"PI_17122__stammdaten__SCHALTZEITDEFINITION__schaltzeiten": {
"properties": {
"code": {
"$ref": "#/components/schemas/code",
"x-edifact-segment": [
"SG29.LIN.SG30.CCI+Z52"
]
}
},
"type": "object"
},
"PI_17122__stammdaten__ZAEHLZEITDEFINITION": {
"properties": {
"zaehlzeiten": {
"items": {
"$ref": "#/components/schemas/PI_17122__stammdaten__ZAEHLZEITDEFINITION__zaehlzeiten"
},
"type": "array"
}
},
"type": "object"
},
"PI_17122__stammdaten__ZAEHLZEITDEFINITION__zaehlzeiten": {
"properties": {
"code": {
"$ref": "#/components/schemas/code",
"x-edifact-segment": [
"SG29.LIN.SG30.CCI"
]
}
},
"type": "object"
},
"Reklamationsgrund": {
"description": "Reklamationsgrund",
"enum": [
"WERTE_ZU_HOCH",
"WERTE_ZU_NIEDRIG",
"WERTE_FEHLEN",
"KONFIGURATION_WIRKT_NICHT",
"KONFIGURATION_WIRKT_TEILWEISE",
"WERTE_WERDEN_NICHT_NACH_VORGABEN_UEBERMITTELT",
"UEBERSICHT_FEHLT",
"UEBERSICHT_UNPLAUSIBEL",
"AUSGEROLLTE_DEFINITION_FEHLT",
"AUSGEROLLTE_DEFINITION_UNPLAUSIBEL"
],
"title": "Reklamationsgrund",
"type": "string"
},
"Sparte": {
"description": "Sparte",
"enum": [
"STROM",
"GAS",
"FERNWAERME",
"NAHWAERME",
"WASSER",
"ABWASSER"
],
"title": "Sparte",
"type": "string"
},
"anfragereferenznummer": {
"description": "Referenz Vorgangsnummer 'aus Anfragenachricht' / ORDERS RFF+TN / IFTSTA RFF+AAV / INSRPT RFF+TN RFF+AAV",
"type": "string"
},
"bemerkung1": {
"description": "bemerkung1",
"type": "string"
},
"bemerkung2": {
"description": "bemerkung2",
"type": "string"
},
"bemerkung3": {
"description": "bemerkung3",
"type": "string"
},
"bemerkung4": {
"description": "bemerkung4",
"type": "string"
},
"bemerkung5": {
"description": "bemerkung5",
"type": "string"
},
"code": {
"description": "Code der Leistungskurve",
"type": "string"
},
"definitionsTyp": {
"$ref": "#/components/schemas/DefinitionsTyp"
},
"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."
},
"positionsnummer": {
"description": "Positionsnummer",
"type": "integer"
},
"reklamationsgrund": {
"$ref": "#/components/schemas/Reklamationsgrund",
"description": "Hier wird für die Reklamation von Werten der Reklamationsgrund angegeben."
},
"rollencodenummer": {
"description": "Gibt die Codenummer der Marktrolle an.",
"type": "string"
},
"sparte": {
"$ref": "#/components/schemas/Sparte",
"description": "Enthält Informationen über die Sparte"
}
}
}
}