{
"openapi": "3.1.0",
"info": {
"title": "START_EINRICHTUNG_KONFIGURATION_ZUORDNUNG_LF_VON_NB (NB)",
"version": "202604",
"description": "The event `START_EINRICHTUNG_KONFIGURATION_ZUORDNUNG_LF_VON_NB` 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_EINRICHTUNG_KONFIGURATION_ZUORDNUNG_LF_VON_NB"
}
],
"paths": {
"/inbound": {
"post": {
"deprecated": false,
"description": "Trigger-Event **START_EINRICHTUNG_KONFIGURATION_ZUORDNUNG_LF_VON_NB** der Marktrolle NB.\n\n**Startet diese Rollensichten** (1):\n\n- [Einrichtung der Konfigurationen aufgrund einer Zuordnung eines LF zu einer Marktlokation bzw. Tranche — NB](/prozessdoku/202604/NB/GPKE-Teil3-einrichtung-der-konfigurationen-aufgrund-einer-zuordnung-eines-lf-zu-einer-marktlokation-bzw-tranche)\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_EINRICHTUNG_KONFIGURATION_ZUORDNUNG_LF_VON_NB",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NB_START_EINRICHTUNG_KONFIGURATION_ZUORDNUNG_LF_VON_NB"
}
}
}
},
"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_EINRICHTUNG_KONFIGURATION_ZUORDNUNG_LF_VON_NB (NB)",
"tags": [
"START_EINRICHTUNG_KONFIGURATION_ZUORDNUNG_LF_VON_NB"
],
"x-actual-endpoint": "POST /inbound",
"x-event-source": "event/202604/[NB]_START_EINRICHTUNG_KONFIGURATION_ZUORDNUNG_LF_VON_NB.yaml",
"x-handbuchsatz": true
}
}
},
"components": {
"securitySchemes": {
"bearer": {
"scheme": "bearer",
"type": "http"
}
},
"schemas": {
"Anfragegrund": {
"description": "Request reason",
"enum": [
"ABGRENZUNG_VON_ENERGIEMENGEN",
"ABGRENZUNG",
"WECHSELEREIGNIS",
"ZWISCHENABLESUNG",
"DIREKTER_VERTRAG_MSB_AN",
"DIREKTER_VERTRAG_MSB_ANN",
"AENDERUNG_IM_LOKATIONSBUENDEL",
"NEUKONFIGURATION",
"KONFIGURATION_UNVERAENDERT"
],
"title": "Request reason",
"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"
},
"BildungTranchengroesse": {
"description": "BildungTranchengroesse",
"enum": [
"PROZENTUAL",
"AUFTEILUNGSFAKTOR",
"AUFTEILUNG_TECHNISCHE_RESSOURCEN",
"BERECHNUNGSFORMEL"
],
"title": "BildungTranchengroesse",
"type": "string"
},
"Energierichtung": {
"description": "Specifies the energy direction of a market location and/or metering location",
"enum": [
"AUSSP",
"EINSP"
],
"title": "Energy direction",
"type": "string"
},
"Marktrolle": {
"description": "A market participant can take on these roles",
"enum": [
"NB",
"LF",
"MSB",
"MSBA",
"GMSB",
"MDL",
"DL",
"BKV",
"BKO",
"UENB",
"KUNDE-SELBST-NN",
"MGV",
"EIV",
"RB",
"KUNDE",
"INTERESSENT",
"KN",
"UBA",
"BIKO",
"ESA"
],
"title": "Market role",
"type": "string"
},
"Mengeneinheit": {
"description": "Unit: measurands that can be determined by measurement or by specification",
"enum": [
"W",
"WH",
"KW",
"KWH",
"KVARH",
"MW",
"MWH",
"STUECK",
"KUBIKMETER",
"STUNDE",
"TAG",
"MONAT",
"JAHR",
"PROZENT",
"ANZAHL",
"VAR",
"KVAR",
"VARH",
"KWHK",
"Z16",
"KWT"
],
"title": "Unit of measurement",
"type": "string"
},
"NB_START_EINRICHTUNG_KONFIGURATION_ZUORDNUNG_LF_VON_NB": {
"properties": {
"stammdaten": {
"anyOf": [
{
"$ref": "#/components/schemas/PI_17134__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 — 17134.",
"examples": [
"17134"
]
}
},
"type": "object"
},
"zusatzdaten": {
"properties": {
"eventname": {
"const": "START_EINRICHTUNG_KONFIGURATION_ZUORDNUNG_LF_VON_NB",
"default": "START_EINRICHTUNG_KONFIGURATION_ZUORDNUNG_LF_VON_NB",
"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_17134__stammdaten": {
"properties": {
"ANFRAGE": {
"items": {
"$ref": "#/components/schemas/PI_17134__stammdaten__ANFRAGE"
},
"type": "array"
},
"AUFTRAG": {
"items": {
"$ref": "#/components/schemas/PI_17134__stammdaten__AUFTRAG"
},
"type": "array"
},
"MARKTLOKATION": {
"items": {
"$ref": "#/components/schemas/PI_17134__stammdaten__MARKTLOKATION"
},
"type": "array"
},
"MESSLOKATION": {
"items": {
"$ref": "#/components/schemas/PI_17134__stammdaten__MESSLOKATION"
},
"type": "array"
},
"TRANCHE": {
"items": {
"$ref": "#/components/schemas/PI_17134__stammdaten__TRANCHE"
},
"type": "array"
}
},
"required": [
"ANFRAGE",
"AUFTRAG"
],
"type": "object",
"title": "17134"
},
"PI_17134__stammdaten__ANFRAGE": {
"properties": {
"anfragetyp": {
"$ref": "#/components/schemas/anfragetyp",
"x-edifact-segment": [
"IMD++[Z66|Z67]"
]
},
"energierichtung": {
"$ref": "#/components/schemas/energierichtung",
"x-edifact-segment": [
"IMD++Z14"
]
},
"lokationsId": {
"$ref": "#/components/schemas/lokationsId",
"x-edifact-segment": [
"SG2.NAD+DP.LOC+172"
]
}
},
"required": [
"energierichtung",
"lokationsId"
],
"type": "object"
},
"PI_17134__stammdaten__AUFTRAG": {
"properties": {
"ausfuehrungsdatum": {
"$ref": "#/components/schemas/ausfuehrungsdatum",
"x-edifact-segment": [
"DTM+203"
]
},
"positionsdaten": {
"items": {
"$ref": "#/components/schemas/PI_17134__stammdaten__AUFTRAG__positionsdaten"
},
"type": "array"
}
},
"required": [
"ausfuehrungsdatum"
],
"type": "object"
},
"PI_17134__stammdaten__AUFTRAG__positionsdaten": {
"properties": {
"anfragegrund": {
"$ref": "#/components/schemas/anfragegrund",
"x-edifact-segment": [
"SG29.LIN++Z16.IMD++[Z64|Z65]"
]
},
"positionsnummer": {
"$ref": "#/components/schemas/positionsnummer",
"x-edifact-segment": [
"SG29.LIN++Z16",
"SG29.LIN++Z19",
"SG29.LIN++Z54"
]
}
},
"type": "object"
},
"PI_17134__stammdaten__MARKTLOKATION": {
"properties": {
"marktlokationsId": {
"$ref": "#/components/schemas/marktlokationsId",
"x-edifact-segment": [
"SG2.NAD+DEB.SG3.RFF+Z59",
"SG2.NAD+DP.SG3.RFF+Z59",
"SG2.NAD+SU.SG3.RFF+Z18",
"SG2.NAD+SU.SG3.RFF+Z59",
"SG2.NAD+Z31.SG3.RFF+Z18"
]
},
"marktrollen": {
"items": {
"$ref": "#/components/schemas/PI_17134__stammdaten__MARKTLOKATION__marktrollen"
},
"type": "array"
},
"zaehlwerke": {
"items": {
"$ref": "#/components/schemas/PI_17134__stammdaten__MARKTLOKATION__zaehlwerke"
},
"type": "array"
}
},
"type": "object"
},
"PI_17134__stammdaten__MARKTLOKATION__marktrollen": {
"properties": {
"marktrolle": {
"$ref": "#/components/schemas/marktrolle",
"x-edifact-segment": [
"SG2.NAD+DEB",
"SG2.NAD+SU",
"SG2.NAD+Z31"
]
},
"rollencodenummer": {
"$ref": "#/components/schemas/rollencodenummer",
"x-edifact-segment": [
"SG2.NAD+DEB",
"SG2.NAD+SU",
"SG2.NAD+Z31"
]
},
"rollencodetyp": {
"$ref": "#/components/schemas/rollencodetyp",
"x-edifact-segment": [
"SG2.NAD+DEB",
"SG2.NAD+SU",
"SG2.NAD+Z31"
]
},
"weiterverpflichtet": {
"$ref": "#/components/schemas/weiterverpflichtet",
"x-edifact-segment": [
"SG2.NAD+DEB",
"SG2.NAD+SU",
"SG2.NAD+Z31"
]
}
},
"type": "object"
},
"PI_17134__stammdaten__MARKTLOKATION__zaehlwerke": {
"properties": {
"messprodukt": {
"$ref": "#/components/schemas/messprodukt",
"x-edifact-segment": [
"SG29.LIN++Z54.PIA+5"
]
},
"verwendungszwecke": {
"items": {
"$ref": "#/components/schemas/PI_17134__stammdaten__MARKTLOKATION__zaehlwerke__verwendungszwecke"
},
"type": "array"
},
"zaehlzeiten": {
"$ref": "#/components/schemas/PI_17134__stammdaten__MARKTLOKATION__zaehlwerke__zaehlzeiten"
}
},
"type": "object"
},
"PI_17134__stammdaten__MARKTLOKATION__zaehlwerke__verwendungszwecke": {
"properties": {
"marktrolle": {
"$ref": "#/components/schemas/marktrolle",
"x-edifact-segment": [
"SG29.LIN++Z54.SG30.CCI+ZA7.CAV",
"SG29.LIN++Z54.SG30.CCI+ZA8.CAV",
"SG29.LIN++Z54.SG30.CCI+ZA9.CAV"
]
},
"zweck": {
"$ref": "#/components/schemas/zweck",
"x-edifact-segment": [
"SG29.LIN++Z54.SG30.CCI+ZA7.CAV",
"SG29.LIN++Z54.SG30.CCI+ZA8.CAV",
"SG29.LIN++Z54.SG30.CCI+ZA9.CAV"
]
}
},
"type": "object"
},
"PI_17134__stammdaten__MARKTLOKATION__zaehlwerke__zaehlzeiten": {
"properties": {
"zaehlzeitDefinition": {
"$ref": "#/components/schemas/zaehlzeitDefinition",
"x-edifact-segment": [
"SG29.LIN++Z54.SG30.CCI+[Z39|Z41]"
]
}
},
"type": "object"
},
"PI_17134__stammdaten__MESSLOKATION": {
"properties": {
"messlokationsId": {
"$ref": "#/components/schemas/messlokationsId",
"x-edifact-segment": [
"SG29.LIN++Z19.SG34.RFF+Z19"
]
},
"zaehlwerke": {
"items": {
"$ref": "#/components/schemas/PI_17134__stammdaten__MESSLOKATION__zaehlwerke"
},
"type": "array"
}
},
"type": "object"
},
"PI_17134__stammdaten__MESSLOKATION__zaehlwerke": {
"properties": {
"messprodukt": {
"$ref": "#/components/schemas/messprodukt",
"x-edifact-segment": [
"SG29.LIN++Z19.PIA+5"
]
},
"zaehlzeiten": {
"$ref": "#/components/schemas/PI_17134__stammdaten__MESSLOKATION__zaehlwerke__zaehlzeiten"
}
},
"type": "object"
},
"PI_17134__stammdaten__MESSLOKATION__zaehlwerke__zaehlzeiten": {
"properties": {
"zaehlzeitDefinition": {
"$ref": "#/components/schemas/zaehlzeitDefinition",
"x-edifact-segment": [
"SG29.LIN++Z19.SG30.CCI+[Z39|Z41]"
]
}
},
"type": "object"
},
"PI_17134__stammdaten__TRANCHE": {
"properties": {
"aufteilungsmenge": {
"$ref": "#/components/schemas/PI_17134__stammdaten__TRANCHE__aufteilungsmenge"
},
"bildungTranchengroesse": {
"$ref": "#/components/schemas/bildungTranchengroesse",
"x-edifact-segment": [
"SG29.LIN++Z16.SG30.CCI+Z37"
]
},
"marktrollen": {
"items": {
"$ref": "#/components/schemas/PI_17134__stammdaten__TRANCHE__marktrollen"
},
"type": "array"
},
"tranchenId": {
"$ref": "#/components/schemas/tranchenId",
"x-edifact-segment": [
"SG2.NAD+DP.SG3.RFF+Z20",
"SG2.NAD+SU.SG3.RFF+Z20",
"SG29.LIN++Z16.SG34.RFF+Z20"
]
},
"zaehlwerke": {
"items": {
"$ref": "#/components/schemas/PI_17134__stammdaten__TRANCHE__zaehlwerke"
},
"type": "array"
}
},
"type": "object"
},
"PI_17134__stammdaten__TRANCHE__aufteilungsmenge": {
"properties": {
"einheit": {
"$ref": "#/components/schemas/einheit",
"x-edifact-segment": [
"SG29.LIN++Z16.QTY+11"
]
},
"wert": {
"$ref": "#/components/schemas/wert",
"x-edifact-segment": [
"SG29.LIN++Z16.QTY+11"
]
}
},
"type": "object"
},
"PI_17134__stammdaten__TRANCHE__marktrollen": {
"properties": {
"marktrolle": {
"$ref": "#/components/schemas/marktrolle",
"x-edifact-segment": [
"SG2.NAD+SU"
]
},
"rollencodenummer": {
"$ref": "#/components/schemas/rollencodenummer",
"x-edifact-segment": [
"SG2.NAD+SU"
]
},
"rollencodetyp": {
"$ref": "#/components/schemas/rollencodetyp",
"x-edifact-segment": [
"SG2.NAD+SU"
]
}
},
"type": "object"
},
"PI_17134__stammdaten__TRANCHE__zaehlwerke": {
"properties": {
"messprodukt": {
"$ref": "#/components/schemas/messprodukt",
"x-edifact-segment": [
"SG29.LIN++Z16.PIA+5"
]
},
"verwendungszwecke": {
"items": {
"$ref": "#/components/schemas/PI_17134__stammdaten__TRANCHE__zaehlwerke__verwendungszwecke"
},
"type": "array"
}
},
"type": "object"
},
"PI_17134__stammdaten__TRANCHE__zaehlwerke__verwendungszwecke": {
"properties": {
"marktrolle": {
"$ref": "#/components/schemas/marktrolle",
"x-edifact-segment": [
"SG29.LIN++Z16.SG30.CCI+ZA7.CAV",
"SG29.LIN++Z16.SG30.CCI+ZA8.CAV",
"SG29.LIN++Z16.SG30.CCI+ZA9.CAV"
]
},
"zweck": {
"$ref": "#/components/schemas/zweck",
"x-edifact-segment": [
"SG29.LIN++Z16.SG30.CCI+ZA7.CAV",
"SG29.LIN++Z16.SG30.CCI+ZA8.CAV",
"SG29.LIN++Z16.SG30.CCI+ZA9.CAV"
]
}
},
"type": "object"
},
"Rollencodetyp": {
"description": "Role code type",
"enum": [
"BDEW",
"GS1",
"GLN",
"DVGW"
],
"title": "Role code type",
"type": "string"
},
"VerwendungszweckValue": {
"description": "Purpose of use value",
"enum": [
"NETZNUTZUNGSABRECHNUNG",
"BILANZKREISABRECHNUNG",
"MEHRMINDERMENGENABRECHNUNG",
"ENDKUNDENABRECHNUNG",
"UEBERMITTLUNG_AN_DAS_HKNR",
"BLINDARBEITSABRECHNUNG",
"ERMITTLUNG_AUSGEGLICHENHEIT_BILANZKREIS",
"BLINDARBEITABRECHNUNG_BETRIEBSFUEHRUNG",
"ES_LIEGT_KEIN_VERWENDUNGSZWECK_VOR"
],
"title": "Purpose of use value",
"type": "string"
},
"anfragegrund": {
"$ref": "#/components/schemas/Anfragegrund"
},
"anfragetyp": {
"$ref": "#/components/schemas/Anfragetyp",
"description": "Type/kind of the request (ORDERS ORDRSP IMD 7081)"
},
"ausfuehrungsdatum": {
"description": "The execution date describes at which point in time an order is to be executed.",
"format": "date-time",
"type": "string"
},
"bildungTranchengroesse": {
"$ref": "#/components/schemas/BildungTranchengroesse"
},
"einheit": {
"$ref": "#/components/schemas/Mengeneinheit"
},
"energierichtung": {
"$ref": "#/components/schemas/Energierichtung",
"description": "Indicates whether energy is fed in or drawn (fed out)."
},
"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"
},
"lokationsId": {
"description": "Which market or metering location this request applies to.",
"type": "string"
},
"marktlokationsId": {
"description": "Identification number of a market location at which energy is either\nconsumed or generated",
"type": "string"
},
"marktrolle": {
"$ref": "#/components/schemas/Marktrolle",
"description": "Indicates the designation of the market role in free text."
},
"messlokationsId": {
"description": "The metering location identification. This is the former metering point identifier,\ne.g. DE 47108151234567",
"type": "string"
},
"messprodukt": {
"description": "messprodukt",
"type": "string"
},
"positionsnummer": {
"description": "Line item number",
"type": "integer"
},
"rollencodenummer": {
"description": "Specifies the code value of the market role.",
"type": "string"
},
"rollencodetyp": {
"$ref": "#/components/schemas/Rollencodetyp",
"description": "Indicates the type of the code."
},
"tranchenId": {
"description": "tranchenId",
"type": "string"
},
"weiterverpflichtet": {
"description": "weiterverpflichtet",
"type": "boolean"
},
"wert": {
"description": "Value",
"format": "float",
"type": "number"
},
"zaehlzeitDefinition": {
"description": "Metering time period definition",
"type": "string"
},
"zweck": {
"description": "zweck",
"items": {
"$ref": "#/components/schemas/VerwendungszweckValue"
},
"nullable": true,
"type": "array"
}
}
}
}