{
  "openapi": "3.1.0",
  "info": {
    "title": "START_VERSAND_COMDIS (NB)",
    "version": "202610",
    "description": "The event `START_VERSAND_COMDIS` of the market role NB as a standalone specification, derived from the trigger API of format version 202610. 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_VERSAND_COMDIS"
    }
  ],
  "paths": {
    "/inbound": {
      "post": {
        "deprecated": false,
        "description": "Trigger-Event **START_VERSAND_COMDIS** der Marktrolle NB.\n\n**Startet diese Rollensichten** (1):\n\n- [Übermittlung des Lieferscheins zur Netznutzungsabrechnung — NB](/prozessdoku/202610/NB/GPKE-Teil2-uebermittlung-des-lieferscheins-zur-netznutzungsabrechnung)\n\n<a href=\"/apis/einzeln/202610/nb/START_VERSAND_COMDIS.json\" data-maco=\"einzelschema\" download target=\"_blank\">Schema nur dieses Ereignisses herunterladen</a> (OpenAPI, JSON).\n\n<Hinweisbereich>\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</Hinweisbereich>",
        "operationId": "trigger_NB_START_VERSAND_COMDIS",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NB_START_VERSAND_COMDIS"
              }
            }
          }
        },
        "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_VERSAND_COMDIS (NB)",
        "tags": [
          "START_VERSAND_COMDIS"
        ],
        "x-actual-endpoint": "POST /inbound",
        "x-event-source": "event/202610/[NB]_START_VERSAND_COMDIS.yaml",
        "x-handbuchsatz": true
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearer": {
        "scheme": "bearer",
        "type": "http"
      }
    },
    "schemas": {
      "GrundlageVerringerungUmlagenGrund": {
        "description": "GrundlageVerringerungUmlagenGrund",
        "enum": [
          "ENFG_STROMSPEICHER_UND_VERLUSTENERGIE",
          "ENFG_ELEKTRISCH_ANGETRIEBENE_WAERMEPUMPEN",
          "ENFG_UMLAGEERHEBUNG_BEI_ANLAGEN_ZUR_VERSTROMUNG_VON_KUPPELGASEN",
          "ENFG_HERSTELLUNG_VON_GRUENEN_WASSERSTOFF",
          "ENFG_STROMKOSTENINTENSIVE_UNTERNEHMEN",
          "ENFG_HERSTELLUNG_VON_WASSERSTOFF_IN_STROMKOSTENINTENSIVEN_UNTERNEHMEN",
          "ENFG_SCHIENENBAHNEN",
          "ENFG_ELEKTRISCHE_BETRIEBENE_BUSSEN_IM_LINIENVERKEHR",
          "ENFG_LANDSTROMANLAGEN"
        ],
        "title": "GrundlageVerringerungUmlagenGrund",
        "type": "string"
      },
      "NB_START_VERSAND_COMDIS": {
        "properties": {
          "stammdaten": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/PI_29002__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 — 29002.",
                "examples": [
                  "29002"
                ]
              },
              "sparte": {
                "$ref": "#/components/schemas/sparte"
              }
            },
            "required": [
              "absender",
              "empfaenger",
              "kategorie",
              "sparte"
            ],
            "type": "object"
          },
          "zusatzdaten": {
            "properties": {
              "eventname": {
                "const": "START_VERSAND_COMDIS",
                "default": "START_VERSAND_COMDIS",
                "type": "string"
              },
              "prozessId": {
                "type": "string"
              }
            },
            "required": [
              "prozessId",
              "eventname"
            ],
            "type": "object"
          }
        },
        "required": [
          "stammdaten",
          "transaktionsdaten",
          "zusatzdaten"
        ],
        "type": "object"
      },
      "PI_29002__stammdaten": {
        "properties": {
          "HANDELSUNSTIMMIGKEIT": {
            "items": {
              "$ref": "#/components/schemas/PI_29002__stammdaten__HANDELSUNSTIMMIGKEIT"
            },
            "type": "array"
          }
        },
        "required": [
          "HANDELSUNSTIMMIGKEIT"
        ],
        "type": "object",
        "title": "29002"
      },
      "PI_29002__stammdaten__HANDELSUNSTIMMIGKEIT": {
        "properties": {
          "begruendung": {
            "$ref": "#/components/schemas/PI_29002__stammdaten__HANDELSUNSTIMMIGKEIT__begruendung"
          },
          "nummer": {
            "$ref": "#/components/schemas/nummer",
            "x-edifact-segment": [
              "SG2.DOC+[Z41|Z42]"
            ]
          },
          "typ": {
            "$ref": "#/components/schemas/typ",
            "x-edifact-segment": [
              "SG2.DOC+[Z41|Z42]"
            ]
          }
        },
        "required": [
          "begruendung",
          "nummer",
          "typ"
        ],
        "type": "object"
      },
      "PI_29002__stammdaten__HANDELSUNSTIMMIGKEIT__begruendung": {
        "properties": {
          "grund": {
            "$ref": "#/components/schemas/grund",
            "x-edifact-segment": [
              "SG2.DOC+[Z41|Z42].SG3.AJT"
            ]
          },
          "hinweis": {
            "$ref": "#/components/schemas/hinweis",
            "x-edifact-segment": [
              "SG2.DOC+[Z41|Z42].SG3.AJT.FTX+ACB"
            ]
          }
        },
        "required": [
          "grund",
          "hinweis"
        ],
        "type": "object"
      },
      "Sparte": {
        "description": "Division",
        "enum": [
          "STROM",
          "GAS",
          "FERNWAERME",
          "NAHWAERME",
          "WASSER",
          "ABWASSER"
        ],
        "title": "Division",
        "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"
      },
      "grund": {
        "description": "Reason for the levy reduction",
        "items": {
          "$ref": "#/components/schemas/GrundlageVerringerungUmlagenGrund"
        },
        "nullable": true,
        "type": "array"
      },
      "hinweis": {
        "description": "Note on the reason",
        "type": "string"
      },
      "kategorie": {
        "description": "Qualifier from the beginning of the EDIFACT message / BGM",
        "type": "string"
      },
      "nummer": {
        "description": "Trade discrepancy number",
        "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"
      },
      "typ": {
        "description": "Old FW - OBSOLET",
        "type": "string"
      }
    }
  }
}