Merge pull request #206 from europace/api-update-pvs-24-12-2024-09-05

Neue Api-Version vom 24-12-2024-09-05
europace · Jan 9, 2025 · 2e0f100 · 2e0f100
2 parents 4dbbfd9 + 4c90106
commit 2e0f100
Show file tree

Hide file tree

Showing 3 changed files with 90 additions and 7 deletions.
diff --git a/api/baufi-passende-vorschlaege-api.yaml b/api/baufi-passende-vorschlaege-api.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   description: 'As consumer, I want to determine appropriate financing proposals based on my situation and preferences. Analyze my needs and compare and find the best offers which fits my needs.'
-  version: 1.0.52
+  version: 1.0.56
   title: Vorschlaege API
   contact:
     name: Europace AG
@@ -247,17 +247,22 @@ components:
           $ref: '#/components/schemas/VorschlaegeErmittlungPartnerDaten'
         kundenangaben:
           $ref: '#/components/schemas/Kundenangaben'
+    ZinsTableauErmittlungsRequest:
+      type: object
+      required:
+        - metadaten
+      properties:
+        metadaten:
+          $ref: '#/components/schemas/ZinsTableauErmittlungPartnerDaten'
+        kundenangaben:
+          $ref: '#/components/schemas/Kundenangaben'
     VorschlaegeErmittlungPartnerDaten:
       type: object
       required:
         - datenkontext
       properties:
         datenkontext:
-          type: string
-          description: In which context (real business or test mode) is the request processed.
-          enum:
-            - TEST_MODUS
-            - ECHT_GESCHAEFT
+          $ref: '#/components/schemas/Datenkontext'
         kundenId:
           type: string
           description: 'Deprecated, will be renamed to extKundenId! Identifier for the user/partner of the API, e.g. ImmoFin AG'
@@ -275,7 +280,7 @@ components:
           description: 'Identifier for the calling client to distinguish client implementations (web/mobile or A/B). Ex. mobile app ver.2.32'
         gewuenschteAnzahlVorschlaege:
           type: integer
-          default: 2
+          default: 3
           minimum: 0
           maximum: 30
         stage:
@@ -287,6 +292,27 @@ components:
         mode:
           type: string
           description: 'Identifier for usage of different modes'
+    ZinsTableauErmittlungPartnerDaten:
+      type: object
+      required:
+        - datenkontext
+      properties:
+        datenkontext:
+          $ref: '#/components/schemas/Datenkontext'
+        extKundenId:
+          type: string
+          description: 'Identifier for the user/partner of the API, e.g. ImmoFin AG'
+          example: ImmoFin
+        gewuenschteZinsbindungen:
+          type: array
+          items:
+            type: integer
+        stage:
+          default: "default"
+          type: string
+        feature:
+          default: "default"
+          type: string
     Kundenangaben:
       type: object
       required:
@@ -304,6 +330,12 @@ components:
           $ref: '#/components/schemas/Finanzierungsbedarf'
         finanzierungsobjekt:
           $ref: '#/components/schemas/Finanzierungsobjekt'
+    Datenkontext:
+      type: string
+      description: In which context (real business or test mode) is the request processed.
+      enum:
+        - TEST_MODUS
+        - ECHT_GESCHAEFT
     Haushalt:
       type: object
       required:

diff --git a/docs/requests/request-interests-with-kundenangaben.json b/docs/requests/request-interests-with-kundenangaben.json
@@ -0,0 +1,44 @@
+{
+  "metadaten": {
+    "datenkontext": "TEST_MODUS",
+    "extKundenId": "BGE21",
+    "gegewuenschteZinsbindungen": [5, 10, 15, 20]
+  },
+  "kundenangaben": {
+    "haushalte": [
+      {
+        "kunden": [
+          {
+            "beschaeftigtSeit": "2018-08-01",
+            "beschaeftigungsArt": "ANGESTELLTER",
+            "arbeitBefristet": false,
+            "einkommenNetto": 6500,
+            "geburtsdatum": "1996-03-09"
+          }
+        ],
+        "finanzielleSituation": {
+          "eigenKapital": 55000,
+          "nichtAbgeloesteRatenkrediteRestschuld": 0
+        }
+      }
+    ],
+    "finanzierungsbedarf": {
+      "finanzierungszweck": "KAUF",
+      "kaufpreis": 299000,
+      "praeferenzen": {
+        "produktAnbieterIds": "DKB,ING_DIBA"
+      }
+    },
+    "finanzierungsobjekt": {
+      "objektArt": "EINFAMILIENHAUS",
+      "vermietet": false,
+      "baujahr": 2000,
+      "gewerblicheNutzung": false,
+      "anschrift": {
+        "plz": "45711"
+      },
+      "wohnflaeche": 150,
+      "endEnergieBedarfAktuell": 80
+    }
+  }
+}
diff --git a/docs/requests/request-interests.json b/docs/requests/request-interests.json
@@ -0,0 +1,7 @@
+{
+  "metadaten": {
+    "datenkontext": "TEST_MODUS",
+    "extKundenId": "BGE21",
+    "gegewuenschteZinsbindungen": [5, 10, 15, 20]
+  }
+}