{
"openapi": "3.1.0",
"info": {
"title": "START_UEBERSICHT_LEISTUNGSKURVENDEF (NB)",
"version": "202604",
"description": "The event `START_UEBERSICHT_LEISTUNGSKURVENDEF` of the market role NB 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_LEISTUNGSKURVENDEF"
}
],
"paths": {
"/inbound": {
"post": {
"deprecated": false,
"description": "Trigger-Event **START_UEBERSICHT_LEISTUNGSKURVENDEF** der Marktrolle NB.\n\n**Startet diese Rollensichten** (1):\n\n- [Übermittlung der Übersicht der Definitionen des NB durch den NB — NB](/prozessdoku/202604/NB/GPKE-Teil3-uebermittlung-der-uebersicht-der-definitionen-des-nb-durch-den-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_NB_START_UEBERSICHT_LEISTUNGSKURVENDEF",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NB_START_UEBERSICHT_LEISTUNGSKURVENDEF"
}
}
}
},
"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_LEISTUNGSKURVENDEF (NB)",
"tags": [
"START_UEBERSICHT_LEISTUNGSKURVENDEF"
],
"x-actual-endpoint": "POST /inbound",
"x-event-source": "event/202604/[NB]_START_UEBERSICHT_LEISTUNGSKURVENDEF.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"
},
"HaeufigkeitZaehlzeit": {
"description": "HaeufigkeitZaehlzeit",
"enum": [
"EINMALIG",
"JAEHRLICH"
],
"title": "HaeufigkeitZaehlzeit",
"type": "string"
},
"NB_START_UEBERSICHT_LEISTUNGSKURVENDEF": {
"properties": {
"stammdaten": {
"anyOf": [
{
"$ref": "#/components/schemas/PI_25007__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 — 25007.",
"examples": [
"25007"
]
},
"sparte": {
"$ref": "#/components/schemas/sparte"
}
},
"required": [
"absender",
"anfrageReferenz",
"empfaenger",
"kategorie",
"sparte"
],
"type": "object"
},
"zusatzdaten": {
"properties": {
"eventname": {
"const": "START_UEBERSICHT_LEISTUNGSKURVENDEF",
"default": "START_UEBERSICHT_LEISTUNGSKURVENDEF",
"type": "string"
},
"prozessId": {
"type": "string"
}
},
"required": [
"prozessId",
"eventname"
],
"type": "object"
}
},
"required": [
"stammdaten",
"transaktionsdaten",
"zusatzdaten"
],
"type": "object"
},
"PI_25007__stammdaten": {
"properties": {
"LEISTUNGSKURVENDEFINITION": {
"items": {
"$ref": "#/components/schemas/PI_25007__stammdaten__LEISTUNGSKURVENDEFINITION"
},
"type": "array"
}
},
"required": [
"LEISTUNGSKURVENDEFINITION"
],
"type": "object",
"title": "25007"
},
"PI_25007__stammdaten__LEISTUNGSKURVENDEFINITION": {
"properties": {
"beginndatum": {
"$ref": "#/components/schemas/beginndatum",
"x-edifact-segment": [
"SG5.IDE+24.DTM+157"
]
},
"leistungskurven": {
"items": {
"$ref": "#/components/schemas/PI_25007__stammdaten__LEISTUNGSKURVENDEFINITION__leistungskurven"
},
"type": "array"
},
"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"
]
}
},
"required": [
"beginndatum",
"notwendigkeit",
"version"
],
"type": "object"
},
"PI_25007__stammdaten__LEISTUNGSKURVENDEFINITION__leistungskurven": {
"properties": {
"code": {
"$ref": "#/components/schemas/code",
"x-edifact-segment": [
"SG5.IDE+24.SG8.SEQ+Z70.SG9.CCI+Z53"
]
},
"haeufigkeit": {
"$ref": "#/components/schemas/haeufigkeit",
"x-edifact-segment": [
"SG5.IDE+24.SG8.SEQ+Z70.SG9.CCI+Z53.CAV+ZE0"
]
},
"uebermittelbarkeit": {
"$ref": "#/components/schemas/uebermittelbarkeit",
"x-edifact-segment": [
"SG5.IDE+24.SG8.SEQ+Z70.SG9.CCI+Z53.CAV+ZD5"
]
}
},
"type": "object"
},
"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"
},
"code": {
"description": "Code of the power curve",
"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"
},
"haeufigkeit": {
"$ref": "#/components/schemas/HaeufigkeitZaehlzeit",
"description": "Frequency of transmission"
},
"kategorie": {
"description": "Qualifier from the beginning of the EDIFACT message / BGM",
"type": "string"
},
"notwendigkeit": {
"$ref": "#/components/schemas/DefinitionenNotwendigkeit"
},
"rollencodenummer": {
"description": "Specifies the code value of the market role.",
"type": "string"
},
"sparte": {
"$ref": "#/components/schemas/Sparte",
"description": "Contains information about the division"
},
"uebermittelbarkeit": {
"$ref": "#/components/schemas/UebermittelbarkeitLeistungskurve"
},
"version": {
"description": "Version of the metering time period definition as a date",
"format": "date-time",
"type": "string"
}
}
}
}