{
"openapi": "3.1.0",
"info": {
"title": "START_ABO_PROFILE (LF)",
"version": "202610",
"description": "Das Ereignis `START_ABO_PROFILE` der Marktrolle LF als eigenständige Spezifikation, abgeleitet aus der Auslöser-API der Formatversion 202610. Genau ein Pfad: `POST /inbound`; das Ereignis ergibt sich aus `zusatzdaten.eventname` im Rumpf."
},
"servers": [
{
"description": "Fake Env",
"url": "https://api.macoapp.de"
}
],
"tags": [
{
"name": "START_ABO_PROFILE"
}
],
"paths": {
"/inbound": {
"post": {
"deprecated": false,
"description": "Trigger-Event **START_ABO_PROFILE** der Marktrolle LF.\n\n**Startet diese Rollensichten** (2):\n\n- [Beendigung eines Abonnements von normierten Profilen und Profilscharen vom LF bzw. ÜNB an NB — LF](/prozessdoku/202610/LF/MaBiS-beendigung-eines-abonnements-von-normierten-profilen-und-profilscharen-vom-lf-bzw-uenb-an-nb)\n- [Start eines Abonnements von normierten Profilen und Profilscharen vom LF bzw. ÜNB an NB — LF](/prozessdoku/202610/LF/MaBiS-start-eines-abonnements-von-normierten-profilen-und-profilscharen-vom-lf-bzw-uenb-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 104 Rumpfvarianten heraus, damit sie einzeln lesbar und ausprobierbar sind.\n\n",
"operationId": "trigger_LF_START_ABO_PROFILE",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LF_START_ABO_PROFILE"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_responses_success"
}
}
},
"description": "Erfolg | Success"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_response_fail"
}
}
},
"description": "Fehler | Fail"
}
},
"security": [
{
"bearer": []
}
],
"summary": "START_ABO_PROFILE (LF)",
"tags": [
"START_ABO_PROFILE"
],
"x-actual-endpoint": "POST /inbound",
"x-event-source": "event/202610/[LF]_START_ABO_PROFILE.yaml",
"x-handbuchsatz": true
}
}
},
"components": {
"securitySchemes": {
"bearer": {
"scheme": "bearer",
"type": "http"
}
},
"schemas": {
"Abonnement": {
"description": "Abonnement",
"enum": [
"START_ABO",
"ENDE_ABO",
"OHNE_ABO"
],
"title": "Abonnement",
"type": "string"
},
"LF_START_ABO_PROFILE": {
"properties": {
"stammdaten": {
"anyOf": [
{
"$ref": "#/components/schemas/PI_17201__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": "Wird dynamisch im Event-Prozess ermittelt. Ein vom Sender mitgegebener Wert wird ignoriert. Im Topic mögliche Prüfis — 17201.",
"examples": [
"17201"
]
},
"typ": {
"$ref": "#/components/schemas/typ"
},
"vorgangsreferenznummer": {
"$ref": "#/components/schemas/vorgangsreferenznummer"
}
},
"required": [
"absender",
"empfaenger",
"kategorie",
"typ",
"vorgangsreferenznummer"
],
"type": "object"
},
"zusatzdaten": {
"properties": {
"eventname": {
"const": "START_ABO_PROFILE",
"default": "START_ABO_PROFILE",
"type": "string"
},
"prozessId": {
"type": "string"
}
},
"required": [
"prozessId",
"eventname"
],
"type": "object"
}
},
"required": [
"stammdaten",
"transaktionsdaten",
"zusatzdaten"
],
"type": "object"
},
"PI_17201__stammdaten": {
"properties": {
"ANFRAGE": {
"items": {
"$ref": "#/components/schemas/PI_17201__stammdaten__ANFRAGE"
},
"type": "array"
},
"AUFTRAG": {
"items": {
"$ref": "#/components/schemas/PI_17201__stammdaten__AUFTRAG"
},
"type": "array"
},
"BILANZIERUNG": {
"items": {
"$ref": "#/components/schemas/PI_17201__stammdaten__BILANZIERUNG"
},
"type": "array"
}
},
"required": [
"ANFRAGE",
"AUFTRAG",
"BILANZIERUNG"
],
"type": "object",
"title": "17201"
},
"PI_17201__stammdaten__ANFRAGE": {
"properties": {
"abonnement": {
"$ref": "#/components/schemas/abonnement",
"x-edifact-segment": [
"IMD++[Z01|Z02]"
]
}
},
"required": [
"abonnement"
],
"type": "object"
},
"PI_17201__stammdaten__AUFTRAG": {
"properties": {
"positionsdaten": {
"items": {
"$ref": "#/components/schemas/PI_17201__stammdaten__AUFTRAG__positionsdaten"
},
"type": "array"
}
},
"required": [
"positionsdaten"
],
"type": "object"
},
"PI_17201__stammdaten__AUFTRAG__positionsdaten": {
"properties": {
"positionsnummer": {
"$ref": "#/components/schemas/positionsnummer",
"x-edifact-segment": [
"SG29.LIN"
]
}
},
"required": [
"positionsnummer"
],
"type": "object"
},
"PI_17201__stammdaten__BILANZIERUNG": {
"properties": {
"lastprofile": {
"items": {
"$ref": "#/components/schemas/PI_17201__stammdaten__BILANZIERUNG__lastprofile"
},
"type": "array"
}
},
"required": [
"lastprofile"
],
"type": "object"
},
"PI_17201__stammdaten__BILANZIERUNG__lastprofile": {
"properties": {
"einspeisung": {
"$ref": "#/components/schemas/einspeisung",
"x-edifact-segment": [
"SG29.LIN.SG30.CCI"
]
},
"profilart": {
"$ref": "#/components/schemas/profilart",
"x-edifact-segment": [
"SG29.LIN.SG30.CCI"
]
}
},
"required": [
"einspeisung",
"profilart"
],
"type": "object"
},
"Profilart": {
"description": "Profilart",
"enum": [
"ART_STANDARDLASTPROFIL",
"ART_TAGESPARAMETERABHAENGIGES_LASTPROFIL",
"ART_LASTPROFIL"
],
"title": "Profilart",
"type": "string"
},
"abonnement": {
"$ref": "#/components/schemas/Abonnement",
"description": "Start oder Ende Abo",
"x-descriptions": {
"EN": "Start or end of subscription"
}
},
"einspeisung": {
"description": "Kennzeichen Einspeisung",
"type": "boolean"
},
"event_response_fail": {
"description": "Fehlermeldung auf Prozessdaten API Aufruf | Error message on process data API call",
"properties": {
"errorCode": {
"description": "Error identifier",
"example": "400",
"type": "string"
},
"message": {
"description": "Technische Meldung | Technische Meldung",
"example": "Validation Failed",
"type": "string"
}
},
"type": "object"
},
"event_responses_success": {
"description": "Erfolgsmeldung auf Prozessdaten API Aufruf | Success message on process data API call",
"properties": {
"businessKey": {
"description": "Einzigartige Kennung des Geschäftsprozesses | Unique identifier of the business process",
"format": "uuid",
"type": "string"
},
"message": {
"description": "Nachricht mit Details zum ausgelösten 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 aus dem Beginn der EDIFact Nachricht / BGM",
"type": "string"
},
"positionsnummer": {
"description": "Positionsnummer",
"type": "integer"
},
"profilart": {
"$ref": "#/components/schemas/Profilart"
},
"rollencodenummer": {
"description": "Gibt die Codenummer der Marktrolle an.",
"type": "string"
},
"typ": {
"description": "Alter FW - OBSOLET",
"type": "string"
},
"vorgangsreferenznummer": {
"description": "Referenznummer des Vorgangs der Anmeldung nach WiM / ORDERS RFF+Z41 / IFTSTA RFF+ACW",
"type": "string"
}
}
}
}