{
"openapi": "3.1.0",
"info": {
"title": "START_REKLAMATION_WERTE (LF)",
"version": "202610",
"description": "The event `START_REKLAMATION_WERTE` of the market role LF 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_REKLAMATION_WERTE"
}
],
"paths": {
"/inbound": {
"post": {
"deprecated": false,
"description": "Trigger-Event **START_REKLAMATION_WERTE** der Marktrolle LF.\n\n**Startet diese Rollensichten** (1):\n\n- [Reklamation vom LF — LF](/prozessdoku/202610/LF/WiM-Teil2-reklamation-vom-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_REKLAMATION_WERTE",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LF_START_REKLAMATION_WERTE"
}
}
}
},
"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_REKLAMATION_WERTE (LF)",
"tags": [
"START_REKLAMATION_WERTE"
],
"x-actual-endpoint": "POST /inbound",
"x-event-source": "event/202610/[LF]_START_REKLAMATION_WERTE.yaml",
"x-handbuchsatz": true
}
}
},
"components": {
"securitySchemes": {
"bearer": {
"scheme": "bearer",
"type": "http"
}
},
"schemas": {
"Anfragetyp": {
"description": "Request type",
"enum": [
"KAUF",
"NUTZUNGSUEBERLASSUNG",
"ABRECHNUNGSBRENNWERT_UND_ZUSTANDSZAHL",
"LASTGANGDATEN",
"ZAEHLERSTAENDE",
"WERTEERMITTLUNG",
"ENERGIEMENGE_EINZELWERT",
"INNERHALB_DER_ARBEITSZEIT",
"AUCH_AUSSERHALB_DER_ARBEITSZEIT",
"WECHSEL_SAEMTLICHER_EINRICHTUNGEN",
"TEILWEISER_WECHSEL",
"AENDERUNG_ZAEHLZEITDEFINITION",
"ABBESTELLUNG_ZAEHLZEITEN",
"ABBESTELLUNG_MESSPRODUKT",
"ANGEBOT_AUF_BASIS_PREISBLATT",
"INDIVIDUELLES_ANGEBOT",
"AENDERUNG_KONFIGURATION",
"KANN_NICHT_ANGEBOTEN_WERDEN",
"NEUKONFIGURATION",
"BEENDIGUNG_KONFIGURATION",
"AKTIVIERUNG_KONFIGURATION"
],
"title": "Request type",
"type": "string"
},
"LF_START_REKLAMATION_WERTE": {
"properties": {
"stammdaten": {
"anyOf": [
{
"$ref": "#/components/schemas/PI_17113__stammdaten"
}
]
},
"transaktionsdaten": {
"properties": {
"pruefidentifikator": {
"description": "Determined dynamically in the event process. A value supplied by the sender is ignored. Check identifiers possible in the topic — 17113.",
"examples": [
"17113"
]
}
},
"type": "object"
},
"zusatzdaten": {
"properties": {
"eventname": {
"const": "START_REKLAMATION_WERTE",
"default": "START_REKLAMATION_WERTE",
"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."
}
},
"PI_17113__stammdaten": {
"properties": {
"ANFRAGE": {
"items": {
"$ref": "#/components/schemas/PI_17113__stammdaten__ANFRAGE"
},
"type": "array"
},
"AUFTRAG": {
"items": {
"$ref": "#/components/schemas/PI_17113__stammdaten__AUFTRAG"
},
"type": "array"
},
"REKLAMATION": {
"items": {
"$ref": "#/components/schemas/PI_17113__stammdaten__REKLAMATION"
},
"type": "array"
}
},
"required": [
"ANFRAGE",
"AUFTRAG",
"REKLAMATION"
],
"type": "object",
"title": "17113"
},
"PI_17113__stammdaten__ANFRAGE": {
"properties": {
"anfragetyp": {
"$ref": "#/components/schemas/anfragetyp",
"x-edifact-segment": [
"IMD++[Z11|Z12|Z35]"
]
}
},
"required": [
"anfragetyp"
],
"type": "object"
},
"PI_17113__stammdaten__AUFTRAG": {
"properties": {
"positionsdaten": {
"items": {
"$ref": "#/components/schemas/PI_17113__stammdaten__AUFTRAG__positionsdaten"
},
"type": "array"
}
},
"required": [
"positionsdaten"
],
"type": "object"
},
"PI_17113__stammdaten__AUFTRAG__positionsdaten": {
"properties": {
"gueltigAb": {
"$ref": "#/components/schemas/gueltigAb",
"x-edifact-segment": [
"SG29.LIN.DTM+7"
]
},
"positionsnummer": {
"$ref": "#/components/schemas/positionsnummer",
"x-edifact-segment": [
"SG29.LIN"
]
}
},
"required": [
"positionsnummer"
],
"type": "object"
},
"PI_17113__stammdaten__REKLAMATION": {
"properties": {
"konfiguration": {
"$ref": "#/components/schemas/konfiguration",
"x-edifact-segment": [
"SG2.NAD+MS.SG3.RFF+AGK"
]
},
"lokationsId": {
"$ref": "#/components/schemas/lokationsId",
"x-edifact-segment": [
"SG2.NAD+DP.LOC+172"
]
},
"obiskennzahl": {
"$ref": "#/components/schemas/obiskennzahl",
"x-edifact-segment": [
"SG29.LIN.PIA+5"
]
},
"reklamationsgrund": {
"$ref": "#/components/schemas/reklamationsgrund",
"x-edifact-segment": [
"SG29.LIN.FTX+[Z04|Z05|Z06]"
]
},
"reklamationsgrundBemerkung": {
"$ref": "#/components/schemas/PI_17113__stammdaten__REKLAMATION__reklamationsgrundBemerkung"
},
"zeitraumMesswertanfrage": {
"$ref": "#/components/schemas/PI_17113__stammdaten__REKLAMATION__zeitraumMesswertanfrage"
}
},
"required": [
"obiskennzahl",
"reklamationsgrund"
],
"type": "object"
},
"PI_17113__stammdaten__REKLAMATION__reklamationsgrundBemerkung": {
"properties": {
"bemerkung1": {
"$ref": "#/components/schemas/bemerkung1",
"x-edifact-segment": [
"SG29.LIN.FTX+[Z04|Z05|Z06]"
]
},
"bemerkung2": {
"$ref": "#/components/schemas/bemerkung2",
"x-edifact-segment": [
"SG29.LIN.FTX+[Z04|Z05|Z06]"
]
},
"bemerkung3": {
"$ref": "#/components/schemas/bemerkung3",
"x-edifact-segment": [
"SG29.LIN.FTX+[Z04|Z05|Z06]"
]
},
"bemerkung4": {
"$ref": "#/components/schemas/bemerkung4",
"x-edifact-segment": [
"SG29.LIN.FTX+[Z04|Z05|Z06]"
]
},
"bemerkung5": {
"$ref": "#/components/schemas/bemerkung5",
"x-edifact-segment": [
"SG29.LIN.FTX+[Z04|Z05|Z06]"
]
}
},
"type": "object"
},
"PI_17113__stammdaten__REKLAMATION__zeitraumMesswertanfrage": {
"properties": {
"enddatum": {
"$ref": "#/components/schemas/enddatum",
"x-edifact-segment": [
"SG29.LIN.DTM+164"
]
},
"startdatum": {
"$ref": "#/components/schemas/startdatum",
"x-edifact-segment": [
"SG29.LIN.DTM+163"
]
}
},
"type": "object"
},
"Reklamationsgrund": {
"description": "Complaint reason",
"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": "Complaint reason",
"type": "string"
},
"anfragetyp": {
"$ref": "#/components/schemas/Anfragetyp",
"description": "Type/kind of the request (ORDERS ORDRSP IMD 7081)"
},
"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"
},
"enddatum": {
"description": "enddatum",
"format": "date-time",
"type": "string"
},
"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"
},
"gueltigAb": {
"description": "gueltigAb",
"format": "date-time",
"type": "string"
},
"konfiguration": {
"description": "Configuration (iMSys) of the meter register",
"type": "string"
},
"lokationsId": {
"description": "Which market or metering location this request applies to.",
"type": "string"
},
"obiskennzahl": {
"description": "obiskennzahl",
"type": "string"
},
"positionsnummer": {
"description": "Line item number",
"type": "integer"
},
"reklamationsgrund": {
"$ref": "#/components/schemas/Reklamationsgrund",
"description": "This specifies the reason for the complaint about values."
},
"startdatum": {
"description": "startdatum",
"format": "date-time",
"type": "string"
}
}
}
}