[MTV-5764] update api-doku (#111)

europace · Sep 11, 2023 · f8cb31d · f8cb31d
1 parent 61b427d
commit f8cb31d
Show file tree

Hide file tree

Showing 2 changed files with 64 additions and 2 deletions.
diff --git a/swagger.json b/swagger.json
@@ -2,7 +2,7 @@
   "swagger": "2.0",
   "info": {
     "description": "Mit dieser API können die Vorgänge aus der Europace Plattform ausgelesen werden.",
-    "version": "2.33",
+    "version": "2.34",
     "title": "Vorgänge API",
     "contact": {
       "name": "Europace AG",
@@ -3612,6 +3612,38 @@
       "title": "Eintrag",
       "description": "Eine Einzahlung oder Auszahlung im Zahlungsplan"
     },
+    "EnergieEffizienzAusweis": {
+      "type": "object",
+      "properties": {
+        "ausweisTyp": {
+          "type": "string",
+          "enum": [
+            "ENDENERGIEBEDARF",
+            "ENDENERGIEVERBRAUCH"
+          ]
+        },
+        "endEnergie": {
+          "type": "number",
+          "format": "double"
+        },
+        "primaerEnergieTraeger": {
+          "type": "string",
+          "enum": [
+            "ABFAELLE",
+            "BRAUNKOHLE",
+            "HOLZ",
+            "NETZSTROM",
+            "OEL_GAS",
+            "PHOTOVOLTAIK_WINDKRAFT",
+            "SONSTIGES",
+            "STEINKOHLE",
+            "VERDRAENGUNGSSTROM",
+            "WAERME_KAELTE"
+          ]
+        }
+      },
+      "title": "EnergieEffizienzAusweis"
+    },
     "Entscheidungsreife": {
       "type": "object",
       "required": [
@@ -4160,6 +4192,9 @@
         "einliegerwohnungVorhanden": {
           "type": "boolean"
         },
+        "energieEffizienzAusweis": {
+          "$ref": "#/definitions/EnergieEffizienzAusweis"
+        },
         "geschossLage": {
           "type": "string",
           "enum": [

diff --git a/swagger.yaml b/swagger.yaml
@@ -2,7 +2,7 @@
 swagger: "2.0"
 info:
   description: Mit dieser API können die Vorgänge aus der Europace Plattform ausgelesen werden.
-  version: "2.33"
+  version: "2.34"
   title: Vorgänge API
   contact:
     name: Europace AG
@@ -2531,6 +2531,31 @@ definitions:
         type: number
     title: Eintrag
     description: Eine Einzahlung oder Auszahlung im Zahlungsplan
+  EnergieEffizienzAusweis:
+    type: object
+    properties:
+      ausweisTyp:
+        type: string
+        enum:
+          - ENDENERGIEBEDARF
+          - ENDENERGIEVERBRAUCH
+      endEnergie:
+        type: number
+        format: double
+      primaerEnergieTraeger:
+        type: string
+        enum:
+          - ABFAELLE
+          - BRAUNKOHLE
+          - HOLZ
+          - NETZSTROM
+          - OEL_GAS
+          - PHOTOVOLTAIK_WINDKRAFT
+          - SONSTIGES
+          - STEINKOHLE
+          - VERDRAENGUNGSSTROM
+          - WAERME_KAELTE
+    title: EnergieEffizienzAusweis
   Entscheidungsreife:
     type: object
     required:
@@ -2924,6 +2949,8 @@ definitions:
           - VOLL_AUSGEBAUT
       einliegerwohnungVorhanden:
         type: boolean
+      energieEffizienzAusweis:
+        $ref: '#/definitions/EnergieEffizienzAusweis'
       geschossLage:
         type: string
         enum: