{
"openapi": "3.1.0",
"info": {
"title": "START_VERSAND_STOERUNGSMELDUNG (LF)",
"version": "202610",
"description": "The event `START_VERSAND_STOERUNGSMELDUNG` 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_VERSAND_STOERUNGSMELDUNG"
}
],
"paths": {
"/inbound": {
"post": {
"deprecated": false,
"description": "Trigger-Event **START_VERSAND_STOERUNGSMELDUNG** der Marktrolle LF.\n\n**Startet diese Rollensichten** (1):\n\n- [Störungsbehebung in der Messlokation — LF](/prozessdoku/202610/LF/awh-wim-gas-2-0-storungsbehebung-in-der-messlokation)\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_VERSAND_STOERUNGSMELDUNG",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LF_START_VERSAND_STOERUNGSMELDUNG"
}
}
}
},
"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_VERSAND_STOERUNGSMELDUNG (LF)",
"tags": [
"START_VERSAND_STOERUNGSMELDUNG"
],
"x-actual-endpoint": "POST /inbound",
"x-event-source": "event/202610/[LF]_START_VERSAND_STOERUNGSMELDUNG.yaml",
"x-handbuchsatz": true
}
}
},
"components": {
"securitySchemes": {
"bearer": {
"scheme": "bearer",
"type": "http"
}
},
"schemas": {
"Auftragsstatus": {
"description": "Order status",
"enum": [
"GESCHEITERT",
"ERFOLGREICH",
"LIEFERUNG_GEPLANT",
"GEPLANT",
"ZUGESTIMMT",
"WIDERSPROCHEN",
"STOERUNGSFREI",
"GESTOERT",
"FESTGESTELLTE_STOERUNG",
"VERMUTETE_STOERUNG",
"ABGELEHNT",
"BEENDET",
"ANTWORT_DRITTER",
"BESTAETIGT",
"UMGESETZT",
"ENFG_STROMSPEICHER_UND_VERLUSTENERGIE",
"ENFG_ELEKTRISCH_ANGETRIEBENE_WAERMEPUMPEN",
"ENFG_UMLAGEERHEBUNG_BEI_ANLAGEN_ZUR_VERSTROMUNG_VON_KUPPELGASEN",
"ENFG_HERSTELLUNG_VON_GRUENEN_WASSERSTOFF",
"ENFG_STROMKOSTENINTENSIVE_UNTERNEHMEN",
"ENFG_HERSTELLUNG_VON_WASSERSTOFF_IN_STROMKOSTENINTENSIVEN_UNTERNEHMEN",
"ENFG_SCHIENENBAHNEN",
"ENFG_ELEKTRISCHE_BETRIEBENE_BUSSEN_IM_LINIENVERKEHR",
"ENFG_LANDSTROMANLAGEN",
"AENDERUNG_DER_DATEN",
"KEINE_AENDERUNG_DER_DATEN",
"ZEITREIHE_AKZEPTIERT",
"ZEITREIHE_NICHT_AKZEPTIERT"
],
"title": "Order status",
"type": "string"
},
"LF_START_VERSAND_STOERUNGSMELDUNG": {
"properties": {
"stammdaten": {
"anyOf": [
{
"$ref": "#/components/schemas/PI_23001__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": "Determined dynamically in the event process. A value supplied by the sender is ignored. Check identifiers possible in the topic — 23001.",
"examples": [
"23001"
]
},
"sparte": {
"$ref": "#/components/schemas/sparte"
}
},
"required": [
"absender",
"empfaenger",
"kategorie",
"sparte"
],
"type": "object"
},
"zusatzdaten": {
"properties": {
"eventname": {
"const": "START_VERSAND_STOERUNGSMELDUNG",
"default": "START_VERSAND_STOERUNGSMELDUNG",
"type": "string"
},
"prozessId": {
"type": "string"
}
},
"required": [
"prozessId",
"eventname"
],
"type": "object"
}
},
"required": [
"stammdaten",
"transaktionsdaten",
"zusatzdaten"
],
"type": "object"
},
"PI_23001__stammdaten": {
"properties": {
"STATUSMITTEILUNG": {
"items": {
"$ref": "#/components/schemas/PI_23001__stammdaten__STATUSMITTEILUNG"
},
"type": "array"
}
},
"required": [
"STATUSMITTEILUNG"
],
"type": "object",
"title": "23001"
},
"PI_23001__stammdaten__STATUSMITTEILUNG": {
"properties": {
"positionsdaten": {
"items": {
"$ref": "#/components/schemas/PI_23001__stammdaten__STATUSMITTEILUNG__positionsdaten"
},
"type": "array"
}
},
"required": [
"positionsdaten"
],
"type": "object"
},
"PI_23001__stammdaten__STATUSMITTEILUNG__positionsdaten": {
"properties": {
"auftragsstatus": {
"$ref": "#/components/schemas/auftragsstatus",
"x-edifact-segment": [
"SG3.DOC+21.SG7.LIN.STS+Z06"
]
},
"begruendung": {
"$ref": "#/components/schemas/PI_23001__stammdaten__STATUSMITTEILUNG__positionsdaten__begruendung"
},
"lokationsId": {
"$ref": "#/components/schemas/lokationsId",
"x-edifact-segment": [
"SG3.DOC+21.SG7.LIN.SG8.NAD+DP.LOC+172"
]
},
"positionsnummer": {
"$ref": "#/components/schemas/positionsnummer",
"x-edifact-segment": [
"SG3.DOC+21.SG7.LIN"
]
},
"verwendungAb": {
"$ref": "#/components/schemas/verwendungAb",
"x-edifact-segment": [
"SG3.DOC+21.SG7.LIN.DTM+163"
]
}
},
"required": [
"auftragsstatus",
"lokationsId",
"positionsnummer"
],
"type": "object"
},
"PI_23001__stammdaten__STATUSMITTEILUNG__positionsdaten__begruendung": {
"properties": {
"begruendung1": {
"$ref": "#/components/schemas/begruendung1",
"x-edifact-segment": [
"SG3.DOC+21.SG7.LIN.FTX+ACD"
]
},
"begruendung2": {
"$ref": "#/components/schemas/begruendung2",
"x-edifact-segment": [
"SG3.DOC+21.SG7.LIN.FTX+ACD"
]
},
"begruendung3": {
"$ref": "#/components/schemas/begruendung3",
"x-edifact-segment": [
"SG3.DOC+21.SG7.LIN.FTX+ACD"
]
},
"begruendung4": {
"$ref": "#/components/schemas/begruendung4",
"x-edifact-segment": [
"SG3.DOC+21.SG7.LIN.FTX+ACD"
]
},
"begruendung5": {
"$ref": "#/components/schemas/begruendung5",
"x-edifact-segment": [
"SG3.DOC+21.SG7.LIN.FTX+ACD"
]
}
},
"type": "object"
},
"Sparte": {
"description": "Division",
"enum": [
"STROM",
"GAS",
"FERNWAERME",
"NAHWAERME",
"WASSER",
"ABWASSER"
],
"title": "Division",
"type": "string"
},
"auftragsstatus": {
"$ref": "#/components/schemas/Auftragsstatus"
},
"begruendung1": {
"description": "Reason line 1",
"type": "string"
},
"begruendung2": {
"description": "Reason line 2",
"type": "string"
},
"begruendung3": {
"description": "Reason line 3",
"type": "string"
},
"begruendung4": {
"description": "Reason line 4",
"type": "string"
},
"begruendung5": {
"description": "Reason line 5",
"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"
},
"kategorie": {
"description": "Qualifier from the beginning of the EDIFACT message / BGM",
"type": "string"
},
"lokationsId": {
"description": "Which market or metering location this request applies to.",
"type": "string"
},
"positionsnummer": {
"description": "Line item number",
"type": "integer"
},
"rollencodenummer": {
"description": "Specifies the code value of the market role.",
"type": "string"
},
"sparte": {
"$ref": "#/components/schemas/Sparte",
"description": "Contains information about the division"
},
"verwendungAb": {
"description": "verwendungAb",
"format": "date-time",
"type": "string"
}
}
}
}