GET /v2/vorgaenge/{vorgangsNummer}/gemerkteAngebote-
diff --git a/README.md b/README.md index 3d9b152..2774ea2 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ API Definition zum Auslesen von Vorgängen aus der Europace-Plattform aus Sicht # Dokumentation -*Aktuelle Version: 2.14* +*Aktuelle Version: 2.15* ### Swagger Spezifikationen Die API ist vollständig in Swagger definiert. Die Swagger Definitionen werden sowohl im JSON- ([swagger.json](swagger.json)) als auch im YAML-Format ([swagger.yaml](swagger.yaml)) zur Verfügung gestellt. diff --git a/dokumentation/index.html b/dokumentation/index.html index 2ffe75a..ae86d87 100644 --- a/dokumentation/index.html +++ b/dokumentation/index.html @@ -536,18 +536,24 @@
Version : 2.14
+Version : 2.15
GET /v2/vorgaenge/{vorgangsNummer}/gemerkteAngebote-
Als Parameter wird die in BaufiSmart erzeugte Vorgangsnummer erwartet. Gemerkte Angebote sind: explizit gemerkte Angebote - in BaufiSmart, ausgehändigte Finanzierungsvorschläge, Empfehlungen des Bearbeiters, Wünsche des Antragstellers, - angefragte- und angenommene Angebote.
+GET /v2/vorgaenge/{vorgangsNummer}/finanzierungsvorschlaege
vorgangsNummer
+Die Nummer des Vorgangs zu dem die Finanzierungsvorschläge erzeugt wurden.
string
@@ -2350,7 +2353,7 @@OK
application/json;charset=UTF-8
application/json;charset=UTF-8
+
+
+
+
+ Path + |
+
+
+
+
+
+ finanzierungsvorschlagId |
+
+
+
+
+
+ Die Id des Finanzierungsvorschlags. + |
+
+
+
+
+
+ string + |
+ |||||
@@ -2536,7 +2566,7 @@ Parameter
|
@@ -2585,7 +2615,7 @@
-
vorgangsNummer +Die Nummer des Vorgangs zu dem die Finanzierungsvorschläge erzeugt wurden. Antworten
|
@@ -2776,219 +2806,869 @@ SicherheitTyp |
Name |
-Scopes |
- |
-
- oauth2 - |
-
-
- |
-
- API - |
PUT /v2/vorgaenge/{vorgangsNummer}/kundenBetreuer-
Typ | -Name | -Beschreibung | -Typ | -
---|---|---|---|
- Path - |
-
- vorgangsNummer |
-
- vorgangsNummer - |
-
- string - |
-
- Body - |
-
- partnerDTO |
-
- partnerDTO - |
-
-
- |
-
HTTP Code | -Beschreibung | -Typ | -
---|---|---|
- 201 - |
-
- Created - |
-
- Kein Inhalt - |
-
- 204 - |
-
- No Content - |
-
- Kein Inhalt - |
-
- 401 - |
-
- Unauthorized - |
-
- Kein Inhalt - |
-
- 403 - |
-
- Forbidden - |
-
- Kein Inhalt - |
-
- 404 - |
-
- Not Found - |
-
- Kein Inhalt - |
-
application/json;charset=UTF-8
Typ | -Name | -Scopes | -
---|---|---|
- oauth2 - |
-
-
- |
-
- API - |
-
GET /v2/vorgaenge/{vorgangsNummer}/vorgangsBearbeiter-
Als Parameter wird die Vorgangsnummer verwendet, die aus BaufiSmart erzeugt wurde.
-Scopes | + + +||
---|---|---|
+
+
+
+
+ oauth2 + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+ API + |
+
GET /v2/vorgaenge/{vorgangsNummer}/gemerkteAngebote+
Als Parameter wird die in BaufiSmart erzeugte Vorgangsnummer erwartet. Gemerkte Angebote sind: explizit + gemerkte Angebote in BaufiSmart, ausgehändigte Finanzierungsvorschläge, Empfehlungen des Bearbeiters, Wünsche + des Antragstellers, angefragte- und angenommene Angebote.
+Typ | +Name | +Beschreibung | +Typ | +
---|---|---|---|
+
+
+
+
+ Path + |
+
+
+
+
+
+ vorgangsNummer |
+
+
+
+
+
+ vorgangsNummer + |
+
+
+
+
+
+ string + |
+
HTTP Code | +Beschreibung | +Typ | +
---|---|---|
+
+
+
+
+ 200 + |
+
+
+
+
+
+ OK + |
+
+
+
+
+ |
+
+
+
+
+
+ 401 + |
+
+
+
+
+
+ Unauthorized + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+ 403 + |
+
+
+
+
+
+ Forbidden + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+ 404 + |
+
+
+
+
+
+ Not Found + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+ 405 + |
+
+
+
+
+
+ Method Not Allowed + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+ 500 + |
+
+
+
+
+
+ Internal Server Error + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+ 502 + |
+
+
+
+
+
+ Bad Gateway + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+ 504 + |
+
+
+
+
+
+ Gateway Timeout + |
+
+
+
+
+
+
+ |
+
application/json;charset=UTF-8
Typ | +Name | +Scopes | +
---|---|---|
+
+
+
+
+ oauth2 + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+ API + |
+
GET /v2/vorgaenge/{vorgangsNummer}/kundenBetreuer+
Als Parameter wird die Vorgangsnummer verwendet, die aus BaufiSmart erzeugt wurde.
+Typ | +Name | +Beschreibung | +Typ | +
---|---|---|---|
+
+
+
+
+ Path + |
+
+
+
+
+
+ vorgangsNummer |
+
+
+
+
+
+ vorgangsNummer + |
+
+
+
+
+
+ string + |
+
HTTP Code | +Beschreibung | +Typ | +
---|---|---|
+
+
+
+
+ 200 + |
+
+
+
+
+
+ OK + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+ 401 + |
+
+
+
+
+
+ Unauthorized + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+ 403 + |
+
+
+
+
+
+ Forbidden + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+ 404 + |
+
+
+
+
+
+ Not Found + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+ 405 + |
+
+
+
+
+
+ Method Not Allowed + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+ 500 + |
+
+
+
+
+
+ Internal Server Error + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+ 502 + |
+
+
+
+
+
+ Bad Gateway + |
+
+
+
+
+
+
+ |
+
+
+
+
+
+ 504 + |
+
+
+
+
+
+ Gateway Timeout + |
+
+
+
+
+
+
+ |
+
application/json;charset=UTF-8
Typ | +Name | +Scopes | +
---|---|---|
+
+
+
+
+ oauth2 + |
+
+
+
+
+ |
+
+ API + |
+
PUT /v2/vorgaenge/{vorgangsNummer}/kundenBetreuer+
Typ | +Name | +Beschreibung | +Typ | +
---|---|---|---|
+ Path + |
+
+ vorgangsNummer |
+
+ vorgangsNummer + |
+
+ string + |
+
+ Body + |
+
+ partnerDTO |
+
+ partnerDTO + |
+
+
+ |
+
HTTP Code | +Beschreibung | +Typ | +
---|---|---|
+ 201 + |
+
+ Created + |
+
+ Kein Inhalt + |
+
+ 204 + |
+
+ No Content + |
+
+ Kein Inhalt + |
+
+ 401 + |
+
+ Unauthorized + |
+
+ Kein Inhalt + |
+
+ 403 + |
+
+ Forbidden + |
+
+ Kein Inhalt + |
+
+ 404 + |
+
+ Not Found + |
+
+ Kein Inhalt + |
+
application/json;charset=UTF-8
Typ | +Name | +Scopes | +
---|---|---|
+ oauth2 + |
+
+
+ |
+
+ API + |
+
GET /v2/vorgaenge/{vorgangsNummer}/vorgangsBearbeiter+
Als Parameter wird die Vorgangsnummer verwendet, die aus BaufiSmart erzeugt wurde.
+
+
+
+
+
+ adresse |
+
+
+
+
+
+
+ |
+||
beleihungsWert Error |
|||
- traceId |
-
- string - |
+
+
+
+
+
+ traceId |
+
+
+
+
+
+ string + |
Name | +Beschreibung | +Typ | +
---|---|---|
+
+
+
+
+ abschlussGebuehr |
+ + + | +
+
+
+
+
+ number + |
+
+
+
+
+
+ angebotsHinweisFuerAntragsteller |
+
+
+
+
+
+ nur bei neuen extern berechneten Bausparverträgen und bei Gegenangeboten + |
+
+
+
+
+
+ string + |
+
+
+
+
+
+ bausparSumme |
+ + + | +
+
+
+
+
+ number + |
+
+
+
+
+
+ einmalzahlung |
+ + + | +
+
+
+
+
+ number + |
+
+
+
+
+
+ gesamtLaufzeitInJahren |
+ + + | +
+
+
+
+
+ integer (int32) + |
+
+
+
+
+
+ id |
+ + + | +
+
+
+
+
+ string + |
+
+
+
+
+
+ produktAnbieter |
+ + + | +
+
+
+
+
+
+ |
+
+
+
+
+
+ sonderZahlungen |
+ + + | +
+
+
+
+
+ < SonderZahlung > array + |
+
+
+
+
+
+ sparBeginn |
+
+
+
+
+
+ Der berechnete Beginn des Besparens des Bausparvertrags. + |
+
+
+
+
+
+ string (date) + |
+
+
+
+
+
+ sparPhase |
+ + + | +
+
+
+
+
+
+ |
+
+
+
+
+
+ tarif |
+ + + | +
+
+
+
+
+ string + |
+
+
+
+
+
+ tilgungsPhase |
+ + + | +
+
+
+
+
+
+ |
+
+
+
+
+
+ typ |
+ + + | +
+
+
+
+
+ string + |
+
+
+
+
+
+ vertragsBeginn |
+ + + | +
+
+
+
+
+ string (date) + |
+
+
+
+
+
+ vertragsNummer |
+ + + | +
+
+
+
+
+ string + |
+
+
+
+
+
+ verwaltungsgebuehrenJaehrlich |
+ + + | +
+
+
+
+
+ number + |
+
+
+
+
+
+ zuteilungsDatum |
+ + + | +
+
+
+
+
+ string (date) + |
+
wohnlage |
-- |
- enum (GEHOBEN, MITTEL, EINFACH) - |
+
+
+
+ + + | +
+
+
+
+
+ enum (GEHOBEN, MITTEL, EINFACH) + |
Name | -Typ | +
---|
Name | +Typ | +
---|---|
+
+
+
+
+ finanzierungsvorschlaege |
+
+
+
+
+
+ < Finanzierungsvorschlag > array + |
+
+
+
+
+
+ _links |
+
+
+
+
+
+
+ |
+
Ein in BaufiSmart ausgehändigter Finanzierungsvorschlag.
+Name | +Beschreibung | +Typ | +
---|---|---|
+
+
+
+
+ annahmeFrist |
+
+
+
+
+
+ Die Annahmefrist des Angebots. + |
+
+
+
+
+
+ string (date-time) + |
+
+
+
+
+
+ bausparvertraege |
+
+
+
+
+
+ Liste von allen Bausparverträgen, die Bestandteil dieses Finanzierungsvorschlags sind. + |
+
+
+
+
+
+ < EuropaceBausparAngebot > array + |
+
+
+
+
+
+ beleihung |
+ + + | +
+
+
+
+ |
+
+
+
+
+
+ darlehen |
+
+
+
+
+
+ Liste von allen Darlehen, die Bestandteil dieses Finanzierungsvorschlags sind. + |
+
+
+
+
+
+ < Darlehen > array + |
+
+
+
+
+
+ darlehensSumme |
+
+
+
+
+
+ Die gesamte Darlehenssumme in Euro für alle im Finanzierungsvorschlag enthaltenen Darlehen. |
+
+
+
+
+
+ number + |
+
+
+
+
+
+ effektivZins |
+
+
+
+
+
+ Aus allen Darlehens Effektivzinssätzen wird ein aggregierter Mischzins in Prozent ausgegeben. |
+
+
+
+
+
+ number + |
+
+
+
+
+
+ erzeugtAm |
+
+
+
+
+
+ Datum, an welchem der Finanzierungsvorschlag erzeugt wurde. |
+
+
+
+
+
+ string (date-time) + |
+
+
+
+
+
+ id |
+
+
+
+
+
+ Id des Finanzierungsvorschlags + |
+
+
+
+
+
+ string + |
+
+
+
+
+
+ machbarkeitsStatus |
+
+
+
+
+
+ Beispiel : |
+
+
+
+
+
+ enum (MACHBAR, UNTER_VORBEHALT_PRODUZENT, NICHT_MACHBAR) + |
+
+
+
+
+
+ rateMonatlich |
+
+
+
+
+
+ Die gesamte monatliche Rate in Euro. |
+
+
+
+
+
+ number + |
+
+
+
+
+
+ sollZins |
+
+
+
+
+
+ Aus allen Darlehens Sollzinssätzen wird ein aggregierter Sollzins in Prozent ausgegeben. |
+
+
+
+
+
+ number + |
+
+
+
+
+
+ zinsBindung |
+
+
+
+
+
+ Die Zinsbindung wird über alle Darlehen als Intervall in Jahren angegeben. |
+
+
+
+
+
+ string + |
+
+
+
+
+
+ _links |
+ + + | +
+
+
+
+
+
+ |
+
Name | +Typ | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-
-vermietungsInformationen |
+
+
+
+
+
+ vermietungsInformationen |
@@ -8516,16 +9981,20 @@ GrundbuchAngabeName |
-Beschreibung |
-Typ |
- |
+
- anmerkungen Beschreibung |
+ Typ |
+
+ |
+
+
+
+ anmerkungen
| string @@ -10927,12 +12396,14 @@SelfRelAndEreignisse |
+
-
-antraege
+ |
+
+
+
+ antraege
|
@@ -10958,6 +12429,23 @@
SelfRelAndEreignisse
+ |
+
+
+
+
+ finanzierungsvorschlaege
+ |
+
+
+
+
+
+
|
+
+
+
@@ -10981,7 +12469,9 @@ SelfRelAndEreignisseself
@@ -13422,7 +14912,7 @@ | Bezeichnung Bauspartarife |