Neue Beispielanfragen und -antworten (#34)

europace · Feb 26, 2020 · 983a9c7 · 983a9c7
1 parent ae6df62
commit 983a9c7
Show file tree

Hide file tree

Showing 6 changed files with 2,338 additions and 142 deletions.
diff --git a/README.md b/README.md
@@ -10,150 +10,15 @@ Die Version der API orientiert sich am [Semantic Versioning](https://semver.org/
 und ist in der [Swagger Definition](https://github.com/europace-privatkredit/bausparkassen-me-api/blob/master/swagger.yml) enthalten (`info.version`).
 
 1. die `MAJOR` Version wird erhöht bei API inkompatiblen Änderungen (z.B. neue Pflichtangaben)
-2. die  `MINOR` Version wird erhöht bei abwärtskompatiblen API Änderungen (z.B. neue optionale Angaben)
+2. die `MINOR` Version wird erhöht bei abwärtskompatiblen API Änderungen (z.B. neue optionale Angaben)
 3. die `PATCH` Version wird erhöht, wenn die API gleich bleibt, jedoch die Swagger Definition angepasst wird (z.B. Erweiterung oder Anpassung von Beschreibungen in der API)
 
 Die aktuelle Version der API ist jeweils in den [Releases](https://github.com/europace-privatkredit/bausparkassen-me-api/releases) zu finden.
 
-## Beispiel `bonitaetscheck`
+## Beispiele
 
-Dies ist ein einfaches Beispiel, wie eine Haushaltsrechnung in der API aussehen kann.
-
-```
-  "bonitaetscheck": {
-    "name": "Haushaltsrechnung",
-    "ueberschrift": "Beispielbank",
-    "ueberschuss": 2342.19,
-    "bloecke": [
-      {
-        "titel": "Einnahmen",
-        "zeilen": [
-          {
-            "label": "Unselbst\u00e4ndiges Nettoeinkommen",
-            "wert": 4000.00
-          },
-          {
-            "label": "Eink\u00fcnfte aus Nebent\u00e4tigkeit",
-            "wert": 200.00
-          }
-        ],
-        "innerBlock": {
-          "zeilen": [
-            {
-              "label": "Summe Einnahmen",
-              "wert": 4200.00,
-              "hervorgehoben": true
-            }
-          ],
-          "hervorgehoben": true
-        }
-      },
-      {
-        "titel": "Ausgaben",
-        "zeilen": [
-          {
-            "label": "Lebenshaltungskosten",
-            "wert": 857.81
-          },
-          {
-            "label": "Mietausgaben",
-            "wert": 1000.00
-          }
-        ],
-        "innerBlock": {
-          "zeilen": [
-            {
-              "label": "Summe Ausgaben",
-              "wert": 1857.81,
-              "hervorgehoben": true
-            }
-          ],
-          "hervorgehoben": true
-        }
-      },
-      {
-        "titel": "\u00dcberschuss / Fehlbetrag",
-        "innerBlock": {
-          "zeilen": [
-            {
-              "label": "\u00dcberschuss",
-              "wert": 2342.19,
-              "hervorgehoben": true
-            }
-          ],
-          "hervorgehoben": true
-        }
-      }
-    ]
-  }
-  ```
-
-## Beispiel `tilgungsplanBausparvertragMitVorausdarlehen`
-
-Dies ist ein einfaches Beispiel (gekürzte Version mit fiktiven Zahlen), wie ein Tilgungsplan von Vorausdarlehen und Bausparvertrag in der API aussehen kann.
-
-```
-  "tilgungsplanBausparvertragMitVorausdarlehen": {
-    "sparphase": {
-      "eintraege": [
-        {
-          "monat": 9,
-          "jahr": 2019,
-          "vorausdarlehenSaldo": -30000
-        },
-        {
-          "monat": 10,
-          "jahr": 2019,
-          "gesamtrate": 119.02,
-          "vorausdarlehenSollzinsen": -49.87,
-          "vorausdarlehenSaldo": -2930.85,
-          "bausparvertragEinzahlungen": 69.15,
-          "bausparvertragGuthabenzinsen": 0.12,
-          "bausparvertragGebuehren": -487.5,
-          "bausparvertragSaldo": -418.23
-        },
-        ...
-        {
-          "jahr": 2027,
-          "gesamtrate": 1666.35,
-          "vorausdarlehenSollzinsen": -237.65,
-          "bausparvertragEinzahlungen": 968.10,
-          "bausparvertragGuthabenzinsen": 18.23,
-          "bausparvertragGebuehren": -15
-        }
-      ],
-      "werteBeiPhasenEnde": {
-        "gesamtrate": 23090.85,
-        "vorausdarlehenSollzinsen": 9675.75,
-        "vorausdarlehenSaldo": -30000,
-        "bausparvertragEinzahlungen": 13415.10,
-        "bausparvertragGuthabenzinsen": 126.67,
-        "bausparvertragGebuehren": 607.50,
-        "bausparvertragSaldo": 12934.27
-      }
-    },
-    "darlehensphase": {
-      "eintraege": [
-        {
-          "jahr": 2027,
-          "gesamtrate": 1190.25,
-          "bausparvertragTilgung": 1190.25,
-          "bausparvertragSollzinsen": -171.05,
-          "bausparvertragSaldo": -16046.53
-        },
-        ...
-        {
-          "jahr": 2034,
-          "gesamtrate": 130.89,
-          "bausparvertragTilgung": 130.89
-        }
-      ],
-      "werteBeiPhasenEnde": {
-        "gesamtrate": 18460.74,
-        "bausparvertragTilgung": 17236.78,
-        "bausparvertragSollzinsen": -1395.01,
-        "bausparvertragSaldo": 0
-      }
-    }
-  }
-```
+* [Anfrage mit minimalen Angaben](beispiele/anfrage-mit-minimalen-angaben.md)
+* [Anfrage mit vollständigen Angaben (ein Antragsteller)](beispiele/anfrage-mit-vollstaendigen-angaben-ein-antragsteller.md)
+* [Anfrage mit vollständigen Angaben (mehrere Antragsteller im gemeinsamen Haushalt)](beispiele/anfrage-mit-vollstaendigen-angaben-mehrere-antragsteller-im-gemeinsamen-haushalt.md)
+* [Anfrage mit vollständigen Angaben (mehrere Antragsteller in getrennten Haushalten)](beispiele/anfrage-mit-vollstaendigen-angaben-mehrere-antragsteller-in-getrennten-haushalten.md)
+* [Annahme mit vollständigen Angaben (ein Antragsteller)](beispiele/annahme-mit-vollstaendigen-angaben-ein-antragsteller.md)