{
"openapi": "3.1.0",
"info": {
"title": "START_UEBERSICHT_ZAEHLZEITDEF (LF)",
"version": "202604",
"description": "The event `START_UEBERSICHT_ZAEHLZEITDEF` 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_UEBERSICHT_ZAEHLZEITDEF"
}
],
"paths": {
"/inbound": {
"post": {
"deprecated": false,
"description": "Trigger-Event **START_UEBERSICHT_ZAEHLZEITDEF** der Marktrolle LF.\n\n**Startet diese Rollensichten** (1):\n\n- [Übermittlung der Übersicht der Definitionen des LF durch den LF — LF](/prozessdoku/202604/LF/GPKE-Teil3-uebermittlung-der-uebersicht-der-definitionen-des-lf-durch-den-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 105 Rumpfvarianten heraus, damit sie einzeln lesbar und ausprobierbar sind.\n\n",
"operationId": "trigger_LF_START_UEBERSICHT_ZAEHLZEITDEF",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LF_START_UEBERSICHT_ZAEHLZEITDEF"
}
}
}
},
"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_UEBERSICHT_ZAEHLZEITDEF (LF)",
"tags": [
"START_UEBERSICHT_ZAEHLZEITDEF"
],
"x-actual-endpoint": "POST /inbound",
"x-event-source": "event/202604/[LF]_START_UEBERSICHT_ZAEHLZEITDEF.yaml",
"x-handbuchsatz": true
}
}
},
"components": {
"securitySchemes": {
"bearer": {
"scheme": "bearer",
"type": "http"
}
},
"schemas": {
"DefinitionenNotwendigkeit": {
"description": "DefinitionsNecessity",
"enum": [
"ZAEHLZEITDEFINITIONEN_WERDEN_VERWENDET",
"ZAEHLZEITDEFINITIONEN_WERDEN_NICHT_VERWENDET",
"DEFINITIONEN_WERDEN_VERWENDET",
"DEFINITIONEN_WERDEN_NICHT_VERWENDET"
],
"title": "DefinitionsNecessity",
"type": "string"
},
"ErmittlungLeistungsmaximum": {
"description": "ErmittlungLeistungsmaximum",
"enum": [
"VERWENDUNG_HOCHLASTFENSTER",
"KEINE_VERWENDUNG_HOCHLASTFENSTER"
],
"title": "ErmittlungLeistungsmaximum",
"type": "string"
},
"HaeufigkeitZaehlzeit": {
"description": "HaeufigkeitZaehlzeit",
"enum": [
"EINMALIG",
"JAEHRLICH"
],
"title": "HaeufigkeitZaehlzeit",
"type": "string"
},
"LF_START_UEBERSICHT_ZAEHLZEITDEF": {
"properties": {
"stammdaten": {
"anyOf": [
{
"$ref": "#/components/schemas/PI_25004__stammdaten"
}
]
},
"transaktionsdaten": {
"properties": {
"absender": {
"properties": {
"rollencodenummer": {
"$ref": "#/components/schemas/rollencodenummer"
}
},
"type": "object"
},
"anfrageReferenz": {
"$ref": "#/components/schemas/anfrageReferenz"
},
"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 — 25004.",
"examples": [
"25004"
]
},
"sparte": {
"$ref": "#/components/schemas/sparte"
}
},
"required": [
"absender",
"anfrageReferenz",
"empfaenger",
"kategorie",
"sparte"
],
"type": "object"
},
"zusatzdaten": {
"properties": {
"eventname": {
"const": "START_UEBERSICHT_ZAEHLZEITDEF",
"default": "START_UEBERSICHT_ZAEHLZEITDEF",
"type": "string"
},
"prozessId": {
"type": "string"
}
},
"required": [
"prozessId",
"eventname"
],
"type": "object"
}
},
"required": [
"stammdaten",
"transaktionsdaten",
"zusatzdaten"
],
"type": "object"
},
"MarktlokationsTyp": {
"description": "Levy type",
"enum": [
"STANDARD_MARKTLOKATION",
"RUHENDE_MARKTLOKATION",
"KUNDENANLAGE"
],
"title": "Levy type",
"type": "string"
},
"PI_25004__stammdaten": {
"properties": {
"ZAEHLZEITDEFINITION": {
"items": {
"$ref": "#/components/schemas/PI_25004__stammdaten__ZAEHLZEITDEFINITION"
},
"type": "array"
}
},
"required": [
"ZAEHLZEITDEFINITION"
],
"type": "object",
"title": "25004"
},
"PI_25004__stammdaten__ZAEHLZEITDEFINITION": {
"properties": {
"beginndatum": {
"$ref": "#/components/schemas/beginndatum",
"x-edifact-segment": [
"SG5.IDE+24.DTM+157"
]
},
"notwendigkeit": {
"$ref": "#/components/schemas/notwendigkeit",
"x-edifact-segment": [
"SG5.IDE+24.STS+Z36"
]
},
"version": {
"$ref": "#/components/schemas/version",
"x-edifact-segment": [
"SG5.IDE+24.DTM+293"
]
},
"zaehlzeiten": {
"items": {
"$ref": "#/components/schemas/PI_25004__stammdaten__ZAEHLZEITDEFINITION__zaehlzeiten"
},
"type": "array"
},
"zaehlzeitregister": {
"items": {
"$ref": "#/components/schemas/PI_25004__stammdaten__ZAEHLZEITDEFINITION__zaehlzeitregister"
},
"type": "array"
}
},
"required": [
"beginndatum",
"notwendigkeit",
"version"
],
"type": "object"
},
"PI_25004__stammdaten__ZAEHLZEITDEFINITION__zaehlzeiten": {
"properties": {
"beschreibungTyp": {
"$ref": "#/components/schemas/beschreibungTyp",
"x-edifact-segment": [
"SG5.IDE+24.SG8.SEQ+Z42.SG9.CCI+Z39.CAV+ZD3"
]
},
"code": {
"$ref": "#/components/schemas/code",
"x-edifact-segment": [
"SG5.IDE+24.SG8.SEQ+Z42.SG9.CCI+Z39"
]
},
"ermittlungLeistungsmaximum": {
"$ref": "#/components/schemas/ermittlungLeistungsmaximum",
"x-edifact-segment": [
"SG5.IDE+24.SG8.SEQ+Z42.SG9.CCI+Z39.CAV+ZD4"
]
},
"haeufigkeit": {
"$ref": "#/components/schemas/haeufigkeit",
"x-edifact-segment": [
"SG5.IDE+24.SG8.SEQ+Z42.SG9.CCI+Z39.CAV+ZE0"
]
},
"istBestellbar": {
"$ref": "#/components/schemas/istBestellbar",
"x-edifact-segment": [
"SG5.IDE+24.SG8.SEQ+Z42.SG9.CCI+Z39.CAV+ZD7"
]
},
"typ": {
"$ref": "#/components/schemas/typ",
"x-edifact-segment": [
"SG5.IDE+24.SG8.SEQ+Z42.SG9.CCI+Z39.CAV+ZD3"
]
},
"uebermittelbarkeit": {
"$ref": "#/components/schemas/uebermittelbarkeit",
"x-edifact-segment": [
"SG5.IDE+24.SG8.SEQ+Z42.SG9.CCI+Z39.CAV+ZD5"
]
}
},
"type": "object"
},
"PI_25004__stammdaten__ZAEHLZEITDEFINITION__zaehlzeitregister": {
"properties": {
"register": {
"$ref": "#/components/schemas/register",
"x-edifact-segment": [
"SG5.IDE+24.SG8.SEQ+Z41.SG9.CCI+Z38"
]
},
"schwachlastfaehig": {
"$ref": "#/components/schemas/schwachlastfaehig",
"x-edifact-segment": [
"SG5.IDE+24.SG8.SEQ+Z41.SG9.CCI+Z10"
]
},
"zaehlzeitDefinition": {
"$ref": "#/components/schemas/zaehlzeitDefinition",
"x-edifact-segment": [
"SG5.IDE+24.SG8.SEQ+Z41.RFF+Z27"
]
}
},
"type": "object"
},
"Schwachlastfaehig": {
"description": "Off-peak capable",
"enum": [
"SCHWACHLASTFAEHIG",
"NICHT_SCHWACHLASTFAEHIG"
],
"title": "Off-peak capable",
"type": "string"
},
"Sparte": {
"description": "Division",
"enum": [
"STROM",
"GAS",
"FERNWAERME",
"NAHWAERME",
"WASSER",
"ABWASSER"
],
"title": "Division",
"type": "string"
},
"UebermittelbarkeitLeistungskurve": {
"description": "Power curve transmissibility",
"enum": [
"ELEKTRONISCH",
"NICHT_ELEKTRONISCH"
],
"title": "Power curve transmissibility",
"type": "string"
},
"anfrageReferenz": {
"description": "Application number / RFF+AGI",
"type": "string"
},
"beginndatum": {
"description": "The inclusive point in time from which the metering time period definitions are rolled out",
"format": "date-time",
"type": "string"
},
"beschreibungTyp": {
"description": "Description of the metering time definition type",
"type": "string"
},
"code": {
"description": "Code of the power curve",
"type": "string"
},
"ermittlungLeistungsmaximum": {
"$ref": "#/components/schemas/ErmittlungLeistungsmaximum",
"description": "Determination of maximum demand"
},
"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"
},
"haeufigkeit": {
"$ref": "#/components/schemas/HaeufigkeitZaehlzeit",
"description": "Frequency of transmission"
},
"istBestellbar": {
"description": "Can the metering time period be ordered?",
"type": "boolean"
},
"kategorie": {
"description": "Qualifier from the beginning of the EDIFACT message / BGM",
"type": "string"
},
"notwendigkeit": {
"$ref": "#/components/schemas/DefinitionenNotwendigkeit"
},
"register": {
"description": "Metering time period register",
"type": "string"
},
"rollencodenummer": {
"description": "Specifies the code value of the market role.",
"type": "string"
},
"schwachlastfaehig": {
"$ref": "#/components/schemas/Schwachlastfaehig",
"description": "schwachlastfaehig"
},
"sparte": {
"$ref": "#/components/schemas/Sparte",
"description": "Contains information about the division"
},
"typ": {
"$ref": "#/components/schemas/MarktlokationsTyp",
"description": "Typing of the market location as standard market location, dormant market location or customer installation"
},
"uebermittelbarkeit": {
"$ref": "#/components/schemas/UebermittelbarkeitLeistungskurve"
},
"version": {
"description": "Version of the metering time period definition as a date",
"format": "date-time",
"type": "string"
},
"zaehlzeitDefinition": {
"description": "Metering time period definition",
"type": "string"
}
}
}
}