{
"openapi": "3.1.0",
"info": {
"title": "START_ANFRAGE_MESSWERTE (LF)",
"version": "202604",
"description": "The event `START_ANFRAGE_MESSWERTE` of the market role LF as a standalone specification, derived from the trigger API of format version 202604. 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_ANFRAGE_MESSWERTE"
}
],
"paths": {
"/inbound": {
"post": {
"deprecated": false,
"description": "Trigger-Event **START_ANFRAGE_MESSWERTE** der Marktrolle LF.\n\n**Startet diese Rollensichten** (2):\n\n- [Geschäftsdatenanfrage — LF](/prozessdoku/202604/LF/GPKE-Teil4-geschaeftsdatenanfrage)\n- [Geschäftsdatenanfrage vom LF an NB — LF](/prozessdoku/202604/LF/geli-gas-2-0-geschaftsdatenanfrage-vom-lf-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_LF_START_ANFRAGE_MESSWERTE",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LF_START_ANFRAGE_MESSWERTE"
}
}
}
},
"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_ANFRAGE_MESSWERTE (LF)",
"tags": [
"START_ANFRAGE_MESSWERTE"
],
"x-actual-endpoint": "POST /inbound",
"x-event-source": "event/202604/[LF]_START_ANFRAGE_MESSWERTE.yaml",
"x-handbuchsatz": true
}
}
},
"components": {
"securitySchemes": {
"bearer": {
"scheme": "bearer",
"type": "http"
}
},
"schemas": {
"Anfragekategorie": {
"description": "Request category",
"enum": [
"PROZESSDATENBERICHT",
"GERAETEUEBERNAHME",
"WEITERVERPFLICHTUNG_BETRIEB_MELO",
"AENDERUNG_MELO",
"STAMMDATEN_MALO_ODER_MELO",
"BILANZIERTE_MENGE_MEHR_MINDER_MENGEN",
"ALLOKATIONSLISTE_MEHR_MINDER_MENGEN",
"ENERGIEMENGE_UND_LEISTUNGSMAXIMUM",
"ABRECHNUNG_MESSSTELLENBETRIEB_MSB_AN_LF",
"AENDERUNG_PROGNOSEGRUNDLAGE_GERAETEKONFIGURATION",
"AENDERUNG_GERAETEKONFIGURATION",
"REKLAMATION_VON_WERTEN",
"LASTGANG_MALO_TRANCHE",
"SPERRUNG",
"ENTSPERRUNG",
"REKLAMATION_ZAEHLZEITDEFINITION",
"ZEITREIHEN_IM_RAHMEN_BILANZKREISABRECHNUNG",
"GERAETEWECHSELABSICHT",
"AENDERUNG_KONZESSIONSABGABE",
"AENDERUNG_ZAEHLZEITDEFINITION",
"UEBERMITTLUNG_WERTE_AN_ESA",
"AENDERUNG",
"BILANZKREISZUORDNUNGSLISTE",
"CLEARINGLISTE",
"NORMIERTES_PROFIL_PROFILSCHAR",
"REDISPATCH_EINZELZEITREIHE_AUSFALLARBEIT",
"REKLAMATION_PROFIL_PROFILSCHAR",
"STAMMDATEN_MALO",
"STAMMDATEN_MELO",
"STAMMDATEN_TRANCHE",
"BEENDIGUNG_EINER_KONFIGURATION",
"BESTELLUNG_EINER_KONFIGURATION",
"BESTELLUNG_EINES_ANGEBOTS_EINER_KONFIGURATION",
"REKLAMATION_EINER_KONFIGURATION",
"BESTELLUNG_AENDERUNG_NETZENTGELTE_NETZORIENTIERTER_STEUERUNGSMOEGLICHKEIT",
"AENDERUNG_DER_TECHNIK_DER_LOKATION",
"AENDERUNG_INDIVIDUELLER_KONFIGURATION",
"BESTELLUNG_AENDERUNG_ABRECHNUNGSDATEN",
"EINRICHTUNG_KONFIGURATION_AUFGRUND_ZUORDNUNG_LF",
"REKLAMATION_DEFINITION",
"BESTELLUNG_ANGEBOT_AENDERUNG_TECHNIK_LOKATION"
],
"title": "Request category",
"type": "string"
},
"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_ANFRAGE_MESSWERTE": {
"properties": {
"stammdaten": {
"anyOf": [
{
"$ref": "#/components/schemas/PI_17102__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 — 17102.",
"examples": [
"17102"
]
},
"sparte": {
"$ref": "#/components/schemas/sparte"
}
},
"required": [
"absender",
"empfaenger",
"kategorie",
"sparte"
],
"type": "object"
},
"zusatzdaten": {
"properties": {
"eventname": {
"const": "START_ANFRAGE_MESSWERTE",
"default": "START_ANFRAGE_MESSWERTE",
"type": "string"
},
"prozessId": {
"type": "string"
}
},
"required": [
"prozessId",
"eventname"
],
"type": "object"
}
},
"required": [
"stammdaten",
"transaktionsdaten",
"zusatzdaten"
],
"type": "object"
},
"PI_17102__stammdaten": {
"properties": {
"ANFRAGE": {
"items": {
"$ref": "#/components/schemas/PI_17102__stammdaten__ANFRAGE"
},
"type": "array"
},
"AUFTRAG": {
"items": {
"$ref": "#/components/schemas/PI_17102__stammdaten__AUFTRAG"
},
"type": "array"
}
},
"required": [
"ANFRAGE",
"AUFTRAG"
],
"type": "object",
"title": "17102"
},
"PI_17102__stammdaten__ANFRAGE": {
"properties": {
"anfragekategorie": {
"$ref": "#/components/schemas/anfragekategorie",
"x-edifact-segment": [
"BGM+[7|Z28|Z48]"
]
},
"anfragetyp": {
"$ref": "#/components/schemas/anfragetyp",
"x-edifact-segment": [
"IMD++[Z11|Z12|Z35]"
]
},
"lokationsId": {
"$ref": "#/components/schemas/lokationsId",
"x-edifact-segment": [
"SG2.NAD+DP.LOC+172"
]
}
},
"required": [
"anfragekategorie",
"lokationsId"
],
"type": "object"
},
"PI_17102__stammdaten__AUFTRAG": {
"properties": {
"positionsdaten": {
"items": {
"$ref": "#/components/schemas/PI_17102__stammdaten__AUFTRAG__positionsdaten"
},
"type": "array"
}
},
"required": [
"positionsdaten"
],
"type": "object"
},
"PI_17102__stammdaten__AUFTRAG__positionsdaten": {
"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"
]
}
},
"required": [
"enddatum",
"startdatum"
],
"type": "object"
},
"Sparte": {
"description": "Division",
"enum": [
"STROM",
"GAS",
"FERNWAERME",
"NAHWAERME",
"WASSER",
"ABWASSER"
],
"title": "Division",
"type": "string"
},
"anfragekategorie": {
"$ref": "#/components/schemas/Anfragekategorie",
"description": "Category of the request (ORDERS ORDRSP BGM 1001)"
},
"anfragetyp": {
"$ref": "#/components/schemas/Anfragetyp",
"description": "Type/kind of the request (ORDERS ORDRSP IMD 7081)"
},
"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"
},
"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"
},
"rollencodenummer": {
"description": "Specifies the code value of the market role.",
"type": "string"
},
"sparte": {
"$ref": "#/components/schemas/Sparte",
"description": "Contains information about the division"
},
"startdatum": {
"description": "startdatum",
"format": "date-time",
"type": "string"
}
}
}
}