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 @@

Vorgänge API

@@ -587,25 +593,28 @@

Vorgänge API

  • CharSequence
  • Darlehen
  • DarlehensWunsch
  • -
  • Dokument
  • -
  • EffektivZinsErhoehendeKosten
  • -
  • EffektivZinsKosten
  • -
  • EinkuenfteAusNebentaetigkeit
  • -
  • EinnahmenMonatlich
  • -
  • Erbbaurecht
  • -
  • Error
  • -
  • Finanzbedarf
  • -
  • FinanzierungsObjekt
  • -
  • Finanzierungswunsch
  • -
  • Flurstueck
  • -
  • ForwardDarlehensWunsch
  • -
  • Gebaeude
  • -
  • GebaeudeFlaeche
  • +
  • Dokument
  • +
  • EffektivZinsErhoehendeKosten
  • +
  • EffektivZinsKosten
  • +
  • EinkuenfteAusNebentaetigkeit
  • +
  • EinnahmenMonatlich
  • +
  • Erbbaurecht
  • +
  • Error
  • +
  • EuropaceBausparAngebot
  • +
  • Finanzbedarf
  • +
  • FinanzierungsObjekt
  • +
  • FinanzierungsvorschlaegeResource
  • +
  • Finanzierungsvorschlag
  • +
  • Finanzierungswunsch
  • +
  • Flurstueck
  • +
  • ForwardDarlehensWunsch
  • +
  • Gebaeude
  • +
  • GebaeudeFlaeche
  • GemerkteAngeboteResource
  • -
  • GrundbuchAngabe
  • -
  • Grundstueck
  • -
  • Haushalt
  • -
  • HaushaltsPositionen
  • +
  • GrundbuchAngabe
  • +
  • Grundstueck
  • +
  • Haushalt
  • +
  • HaushaltsPositionen
  • HoeheDerRatePraeferenz
  • ImmobilieVerknuepfung
  • KfwDarlehensWunsch
  • @@ -690,7 +699,7 @@

    Übersicht

    Aktuelle Version

    -

    Version : 2.14

    +

    Version : 2.15

    @@ -2276,18 +2285,12 @@
    Sicherheit
    -

    Die Liste der gemerkten Angebote des Vorgangs abrufen

    +

    Als Parameter wird die in BaufiSmart erzeugte Vorgangsnummer erwartet. Bei + Finanzierungsvorschlägen handelt es sich um ausgehändigte Finanzierungsvorschläge in Baufsmart. Achtung: Bei den + ausgegebenen Finanzierungsvorschlägen handelt es sich um Mockdaten.

    -
    GET /v2/vorgaenge/{vorgangsNummer}/gemerkteAngebote
    -
    -
    -
    -
    Beschreibung
    -
    -

    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
    @@ -2317,7 +2320,7 @@
    Parameter
    verpflichtend

    -

    vorgangsNummer

    +

    Die Nummer des Vorgangs zu dem die Finanzierungsvorschläge erzeugt wurden.

    string

    @@ -2350,7 +2353,7 @@
    Antworten

    OK

    -

    GemerkteAngeboteResource

    +

    FinanzierungsvorschlaegeResource

    @@ -2433,16 +2436,16 @@
    Antworten
    -
    -
    Erzeugt
    -
    - +
    +
    Erzeugt
    +
    +
      +
    • +

      application/json;charset=UTF-8

      +
    • +
    +
    -
    Sicherheit
    @@ -2487,16 +2490,12 @@
    Sicherheit
    -

    Den Kundenbetreuer des Vorgangs abrufen

    +

    Als Parameter wird die in BaufiSmart erzeugte Vorgangsnummer und die Id des + Finanzierungsvorschlags erwartet. Achtung: Bei dem ausgegebenen Finanzierungsvorschlag handelt es sich um + Mockdaten.

    -
    GET /v2/vorgaenge/{vorgangsNummer}/kundenBetreuer
    -
    -
    -
    -
    Beschreibung
    -
    -

    Als Parameter wird die Vorgangsnummer verwendet, die aus BaufiSmart erzeugt wurde.

    +
    GET /v2/vorgaenge/{vorgangsNummer}/finanzierungsvorschlaege/{finanzierungsvorschlagId}
    @@ -2517,6 +2516,37 @@
    Parameter
    + + + + + + @@ -2585,7 +2615,7 @@
    Antworten
    @@ -2776,219 +2806,869 @@
    Sicherheit
    - - - - - - - - - - -
    +
    +
    +

    Path

    +
    +
    +
    +
    +
    +

    finanzierungsvorschlagId
    + verpflichtend

    +
    +
    +
    +
    +
    +

    Die Id des Finanzierungsvorschlags.

    +
    +
    +
    +
    +
    +

    string

    +
    +
    +
    @@ -2536,7 +2566,7 @@
    Parameter
    -

    vorgangsNummer

    +

    Die Nummer des Vorgangs zu dem die Finanzierungsvorschläge erzeugt wurden.

    Typ NameScopes
    -

    oauth2

    -
    -

    oauth2

    -
    -

    API

    -
    -
    -
    -
    -

    Den Kundenbetreuer ändern

    -
    -
    -
    PUT /v2/vorgaenge/{vorgangsNummer}/kundenBetreuer
    -
    -
    -
    -
    Parameter
    - ------ - - - - - - - - - - - - - - - - - - - - - - -
    TypNameBeschreibungTyp
    -

    Path

    -
    -

    vorgangsNummer
    -verpflichtend

    -
    -

    vorgangsNummer

    -
    -

    string

    -
    -

    Body

    -
    -

    partnerDTO
    -verpflichtend

    -
    -

    partnerDTO

    -
    -
    -
    -
    Antworten
    - ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    HTTP CodeBeschreibungTyp
    -

    201

    -
    -

    Created

    -
    -

    Kein Inhalt

    -
    -

    204

    -
    -

    No Content

    -
    -

    Kein Inhalt

    -
    -

    401

    -
    -

    Unauthorized

    -
    -

    Kein Inhalt

    -
    -

    403

    -
    -

    Forbidden

    -
    -

    Kein Inhalt

    -
    -

    404

    -
    -

    Not Found

    -
    -

    Kein Inhalt

    -
    -
    -
    -
    Erzeugt
    -
    -
      -
    • -

      application/json;charset=UTF-8

      -
    • -
    -
    -
    -
    -
    Sicherheit
    - ----- - - - - - - - - - - - - - - -
    TypNameScopes
    -

    oauth2

    -
    -

    oauth2

    -
    -

    API

    -
    -
    -
    -
    -

    Den Vorgangsbearbeiter des Vorgangs abrufen

    -
    -
    -
    GET /v2/vorgaenge/{vorgangsNummer}/vorgangsBearbeiter
    -
    -
    -
    -
    Beschreibung
    -
    -

    Als Parameter wird die Vorgangsnummer verwendet, die aus BaufiSmart erzeugt wurde.

    -
    -
    -
    -
    Parameter
    - -----+ + + + + + + + + + +
    Scopes
    +
    +
    +

    oauth2

    +
    +
    +
    +
    +
    +

    oauth2

    +
    +
    +
    +
    +
    +

    API

    +
    +
    +
    +
    +
    +
    +

    Die Liste der gemerkten Angebote des Vorgangs abrufen

    +
    +
    +
    GET /v2/vorgaenge/{vorgangsNummer}/gemerkteAngebote
    +
    +
    +
    +
    Beschreibung
    +
    +

    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.

    +
    +
    +
    +
    Parameter
    + + + + + + + + + + + + + + + + + + + + + + + +
    TypNameBeschreibungTyp
    +
    +
    +

    Path

    +
    +
    +
    +
    +
    +

    vorgangsNummer
    + verpflichtend

    +
    +
    +
    +
    +
    +

    vorgangsNummer

    +
    +
    +
    +
    +
    +

    string

    +
    +
    +
    +
    +
    +
    Antworten
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    HTTP CodeBeschreibungTyp
    +
    +
    +

    200

    +
    +
    +
    +
    +
    +

    OK

    +
    +
    +
    + +
    +
    +
    +

    401

    +
    +
    +
    +
    +
    +

    Unauthorized

    +
    +
    +
    +
    +
    +

    Error

    +
    +
    +
    +
    +
    +

    403

    +
    +
    +
    +
    +
    +

    Forbidden

    +
    +
    +
    +
    +
    +

    Error

    +
    +
    +
    +
    +
    +

    404

    +
    +
    +
    +
    +
    +

    Not Found

    +
    +
    +
    +
    +
    +

    Error

    +
    +
    +
    +
    +
    +

    405

    +
    +
    +
    +
    +
    +

    Method Not Allowed

    +
    +
    +
    +
    +
    +

    Error

    +
    +
    +
    +
    +
    +

    500

    +
    +
    +
    +
    +
    +

    Internal Server Error

    +
    +
    +
    +
    +
    +

    Error

    +
    +
    +
    +
    +
    +

    502

    +
    +
    +
    +
    +
    +

    Bad Gateway

    +
    +
    +
    +
    +
    +

    Error

    +
    +
    +
    +
    +
    +

    504

    +
    +
    +
    +
    +
    +

    Gateway Timeout

    +
    +
    +
    +
    +
    +

    Error

    +
    +
    +
    +
    +
    +
    Erzeugt
    +
    +
      +
    • +

      application/json;charset=UTF-8

      +
    • +
    +
    +
    +
    +
    Sicherheit
    + + + + + + + + + + + + + + + + + + + + +
    TypNameScopes
    +
    +
    +

    oauth2

    +
    +
    +
    +
    +
    +

    oauth2

    +
    +
    +
    +
    +
    +

    API

    +
    +
    +
    +
    +
    +
    +

    Den Kundenbetreuer des Vorgangs abrufen

    +
    +
    +
    GET /v2/vorgaenge/{vorgangsNummer}/kundenBetreuer
    +
    +
    +
    +
    Beschreibung
    +
    +

    Als Parameter wird die Vorgangsnummer verwendet, die aus BaufiSmart erzeugt wurde.

    +
    +
    +
    +
    Parameter
    + + + + + + + + + + + + + + + + + + + + + + + +
    TypNameBeschreibungTyp
    +
    +
    +

    Path

    +
    +
    +
    +
    +
    +

    vorgangsNummer
    + verpflichtend

    +
    +
    +
    +
    +
    +

    vorgangsNummer

    +
    +
    +
    +
    +
    +

    string

    +
    +
    +
    +
    +
    +
    Antworten
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    HTTP CodeBeschreibungTyp
    +
    +
    +

    200

    +
    +
    +
    +
    +
    +

    OK

    +
    +
    +
    +
    +
    +

    Partner

    +
    +
    +
    +
    +
    +

    401

    +
    +
    +
    +
    +
    +

    Unauthorized

    +
    +
    +
    +
    +
    +

    Error

    +
    +
    +
    +
    +
    +

    403

    +
    +
    +
    +
    +
    +

    Forbidden

    +
    +
    +
    +
    +
    +

    Error

    +
    +
    +
    +
    +
    +

    404

    +
    +
    +
    +
    +
    +

    Not Found

    +
    +
    +
    +
    +
    +

    Error

    +
    +
    +
    +
    +
    +

    405

    +
    +
    +
    +
    +
    +

    Method Not Allowed

    +
    +
    +
    +
    +
    +

    Error

    +
    +
    +
    +
    +
    +

    500

    +
    +
    +
    +
    +
    +

    Internal Server Error

    +
    +
    +
    +
    +
    +

    Error

    +
    +
    +
    +
    +
    +

    502

    +
    +
    +
    +
    +
    +

    Bad Gateway

    +
    +
    +
    +
    +
    +

    Error

    +
    +
    +
    +
    +
    +

    504

    +
    +
    +
    +
    +
    +

    Gateway Timeout

    +
    +
    +
    +
    +
    +

    Error

    +
    +
    +
    +
    +
    +
    Erzeugt
    +
    +
      +
    • +

      application/json;charset=UTF-8

      +
    • +
    +
    +
    +
    +
    Sicherheit
    + + + + + + + + + + + + + + + + + + + + +
    TypNameScopes
    +
    +
    +

    oauth2

    +
    +
    +
    +
    +
    +

    oauth2

    +
    +

    API

    +
    +
    +
    +
    +

    Den Kundenbetreuer ändern

    +
    +
    +
    PUT /v2/vorgaenge/{vorgangsNummer}/kundenBetreuer
    +
    +
    +
    +
    Parameter
    + ++++++ + + + + + + + + + + + + + + + + + + + + + + +
    TypNameBeschreibungTyp
    +

    Path

    +
    +

    vorgangsNummer
    +verpflichtend

    +
    +

    vorgangsNummer

    +
    +

    string

    +
    +

    Body

    +
    +

    partnerDTO
    +verpflichtend

    +
    +

    partnerDTO

    +
    +
    +
    +
    Antworten
    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    HTTP CodeBeschreibungTyp
    +

    201

    +
    +

    Created

    +
    +

    Kein Inhalt

    +
    +

    204

    +
    +

    No Content

    +
    +

    Kein Inhalt

    +
    +

    401

    +
    +

    Unauthorized

    +
    +

    Kein Inhalt

    +
    +

    403

    +
    +

    Forbidden

    +
    +

    Kein Inhalt

    +
    +

    404

    +
    +

    Not Found

    +
    +

    Kein Inhalt

    +
    +
    +
    +
    Erzeugt
    +
    +
      +
    • +

      application/json;charset=UTF-8

      +
    • +
    +
    +
    +
    +
    Sicherheit
    + +++++ + + + + + + + + + + + + + + +
    TypNameScopes
    +

    oauth2

    +
    +

    oauth2

    +
    +

    API

    +
    +
    +
    +
    +

    Den Vorgangsbearbeiter des Vorgangs abrufen

    +
    +
    +
    GET /v2/vorgaenge/{vorgangsNummer}/vorgangsBearbeiter
    +
    +
    +
    +
    Beschreibung
    +
    +

    Als Parameter wird die Vorgangsnummer verwendet, die aus BaufiSmart erzeugt wurde.

    +
    +
    +
    +
    Parameter
    + +++++ @@ -3018,7 +3698,7 @@
    Parameter
    -
    Antworten
    +
    Antworten
    @@ -3125,7 +3805,7 @@
    Antworten
    -
    Erzeugt
    +
    Erzeugt
    • @@ -3135,7 +3815,7 @@
      Erzeugt
    -
    Sicherheit
    +
    Sicherheit
    @@ -3173,7 +3853,7 @@

    putVorgangsBearbeiterId

    -
    Parameter
    +
    Parameter
    @@ -3224,7 +3904,7 @@
    Parameter
    -
    Antworten
    +
    Antworten
    @@ -3308,7 +3988,7 @@
    Verarbeitet
    -
    Erzeugt
    +
    Erzeugt
    • @@ -3318,7 +3998,7 @@
      Erzeugt
    -
    Sicherheit
    +
    Sicherheit
    @@ -5400,6 +6080,23 @@

    BeleihungsWert

    + + + + - - + +
    +
    +
    +

    adresse
    + optional

    +
    +
    +
    +
    + +
    +

    beleihungsWert
    @@ -7495,24 +8192,399 @@

    Error

    -

    traceId
    -optional

    -
    -

    string

    -
    +
    +
    +

    traceId
    + optional

    +
    +
    +
    +
    +
    +

    string

    +
    +
    +
    -
    -

    Finanzbedarf

    - ----+
    +

    EuropaceBausparAngebot

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameBeschreibungTyp
    +
    +
    +

    abschlussGebuehr
    + optional

    +
    +
    +
    +
    +
    +
    +
    +

    number

    +
    +
    +
    +
    +
    +

    angebotsHinweisFuerAntragsteller
    + optional

    +
    +
    +
    +
    +
    +

    nur bei neuen extern berechneten Bausparverträgen und bei Gegenangeboten

    +
    +
    +
    +
    +
    +

    string

    +
    +
    +
    +
    +
    +

    bausparSumme
    + optional

    +
    +
    +
    +
    +
    +
    +
    +

    number

    +
    +
    +
    +
    +
    +

    einmalzahlung
    + optional

    +
    +
    +
    +
    +
    +
    +
    +

    number

    +
    +
    +
    +
    +
    +

    gesamtLaufzeitInJahren
    + optional

    +
    +
    +
    +
    +
    +
    +
    +

    integer (int32)

    +
    +
    +
    +
    +
    +

    id
    + optional

    +
    +
    +
    +
    +
    +
    +
    +

    string

    +
    +
    +
    +
    +
    +

    produktAnbieter
    + optional

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    +

    sonderZahlungen
    + optional

    +
    +
    +
    +
    +
    +
    +
    +

    < SonderZahlung > array

    +
    +
    +
    +
    +
    +

    sparBeginn
    + optional

    +
    +
    +
    +
    +
    +

    Der berechnete Beginn des Besparens des Bausparvertrags.

    +
    +
    +
    +
    +
    +

    string (date)

    +
    +
    +
    +
    +
    +

    sparPhase
    + optional

    +
    +
    +
    +
    +
    +
    +
    +

    SparPhase

    +
    +
    +
    +
    +
    +

    tarif
    + optional

    +
    +
    +
    +
    +
    +
    +
    +

    string

    +
    +
    +
    +
    +
    +

    tilgungsPhase
    + optional

    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    +

    typ
    + optional

    +
    +
    +
    +
    +
    +
    +
    +

    string

    +
    +
    +
    +
    +
    +

    vertragsBeginn
    + optional

    +
    +
    +
    +
    +
    +
    +
    +

    string (date)

    +
    +
    +
    +
    +
    +

    vertragsNummer
    + optional

    +
    +
    +
    +
    +
    +
    +
    +

    string

    +
    +
    +
    +
    +
    +

    verwaltungsgebuehrenJaehrlich
    + optional

    +
    +
    +
    +
    +
    +
    +
    +

    number

    +
    +
    +
    +
    +
    +

    zuteilungsDatum
    + optional

    +
    +
    +
    +
    +
    +
    +
    +

    string (date)

    +
    +
    +
    +
    +
    +

    Finanzbedarf

    + + + + + @@ -7975,26 +9047,417 @@

    FinanzierungsObjekt

    - - + + + + +

    wohnlage
    optional

    -
    -

    enum (GEHOBEN, MITTEL, EINFACH)

    -
    +
    +
    +
    +
    +

    enum (GEHOBEN, MITTEL, EINFACH)

    +
    +
    +
    -
    -

    Finanzierungswunsch

    - ---- - - - - +
    +

    FinanzierungsvorschlaegeResource

    +
    NameTyp
    + + + + + + + + + + + + + + + + + + + + +
    NameTyp
    +
    +
    +

    finanzierungsvorschlaege
    + optional

    +
    +
    +
    +
    +
    +

    < Finanzierungsvorschlag > array

    +
    +
    +
    +
    +
    +

    _links
    + optional

    +
    +
    +
    +
    +
    +

    Links

    +
    +
    +
    +
    +
    +

    Finanzierungsvorschlag

    +
    +

    Ein in BaufiSmart ausgehändigter Finanzierungsvorschlag.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameBeschreibungTyp
    +
    +
    +

    annahmeFrist
    + optional

    +
    +
    +
    +
    +
    +

    Die Annahmefrist des Angebots.

    +
    +
    +
    +
    +
    +

    string (date-time)

    +
    +
    +
    +
    +
    +

    bausparvertraege
    + optional

    +
    +
    +
    +
    +
    +

    Liste von allen Bausparverträgen, die Bestandteil dieses Finanzierungsvorschlags sind.

    +
    +
    +
    +
    +
    +

    < EuropaceBausparAngebot > array

    +
    +
    +
    +
    +
    +

    beleihung
    + optional

    +
    +
    +
    +
    +
    + +
    +
    +
    +

    darlehen
    + optional

    +
    +
    +
    +
    +
    +

    Liste von allen Darlehen, die Bestandteil dieses Finanzierungsvorschlags sind.

    +
    +
    +
    +
    +
    +

    < Darlehen > array

    +
    +
    +
    +
    +
    +

    darlehensSumme
    + optional

    +
    +
    +
    +
    +
    +

    Die gesamte Darlehenssumme in Euro für alle im Finanzierungsvorschlag enthaltenen Darlehen.
    + Beispiel : 123.34

    +
    +
    +
    +
    +
    +

    number

    +
    +
    +
    +
    +
    +

    effektivZins
    + optional

    +
    +
    +
    +
    +
    +

    Aus allen Darlehens Effektivzinssätzen wird ein aggregierter Mischzins in Prozent ausgegeben.
    + Beispiel : 2.04

    +
    +
    +
    +
    +
    +

    number

    +
    +
    +
    +
    +
    +

    erzeugtAm
    + optional

    +
    +
    +
    +
    +
    +

    Datum, an welchem der Finanzierungsvorschlag erzeugt wurde.
    + Beispiel : "2021-03-29T15:32:21.698Z"

    +
    +
    +
    +
    +
    +

    string (date-time)

    +
    +
    +
    +
    +
    +

    id
    + optional

    +
    +
    +
    +
    +
    +

    Id des Finanzierungsvorschlags

    +
    +
    +
    +
    +
    +

    string

    +
    +
    +
    +
    +
    +

    machbarkeitsStatus
    + optional

    +
    +
    +
    +
    +
    +

    Beispiel : "MACHBAR"

    +
    +
    +
    +
    +
    +

    enum (MACHBAR, UNTER_VORBEHALT_PRODUZENT, NICHT_MACHBAR)

    +
    +
    +
    +
    +
    +

    rateMonatlich
    + optional

    +
    +
    +
    +
    +
    +

    Die gesamte monatliche Rate in Euro.
    + Beispiel : 123.34

    +
    +
    +
    +
    +
    +

    number

    +
    +
    +
    +
    +
    +

    sollZins
    + optional

    +
    +
    +
    +
    +
    +

    Aus allen Darlehens Sollzinssätzen wird ein aggregierter Sollzins in Prozent ausgegeben.
    + Beispiel : 2.05

    +
    +
    +
    +
    +
    +

    number

    +
    +
    +
    +
    +
    +

    zinsBindung
    + optional

    +
    +
    +
    +
    +
    +

    Die Zinsbindung wird über alle Darlehen als Intervall in Jahren angegeben.
    + Beispiel : "5 - 10 Jahre"

    +
    +
    +
    +
    +
    +

    string

    +
    +
    +
    +
    +
    +

    _links
    + optional

    +
    +
    +
    +
    +
    +
    +
    +

    Links

    +
    +
    +
    +
    +
    +

    Finanzierungswunsch

    + + + + + + + + + @@ -8437,12 +9900,14 @@

    GebaeudeFlaeche

    - + - - - - - - - + + + + + + + - + + + + + + + + @@ -13422,7 +14912,7 @@

    Bezeichnung Bauspartarife

    diff --git a/swagger.json b/swagger.json index 23df2f1..23b5e04 100644 --- 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.14", + "version": "2.15", "title": "Vorgänge API", "contact": { "name": "Europace AG", @@ -655,6 +655,171 @@ ] } }, + "/v2/vorgaenge/{vorgangsNummer}/finanzierungsvorschlaege": { + "get": { + "tags": [ + "Finanzierungsvorschlag", + "Vorgänge" + ], + "summary": "Als Parameter wird die in BaufiSmart erzeugte Vorgangsnummer erwartet. Bei Finanzierungsvorschlägen handelt es sich um ausgehändigte Finanzierungsvorschläge in Baufsmart. Achtung: Bei den ausgegebenen Finanzierungsvorschlägen handelt es sich um Mockdaten.", + "operationId": "getFinanzierungsvorschlaege", + "produces": [ + "application/json;charset=UTF-8" + ], + "parameters": [ + { + "name": "vorgangsNummer", + "in": "path", + "description": "Die Nummer des Vorgangs zu dem die Finanzierungsvorschläge erzeugt wurden.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FinanzierungsvorschlaegeResource" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "404": { + "description": "Not Found", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "405": { + "description": "Method Not Allowed", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "502": { + "description": "Bad Gateway", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "504": { + "description": "Gateway Timeout", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "security": [ + { + "oauth2": [ + "API" + ] + } + ] + } + }, + "/v2/vorgaenge/{vorgangsNummer}/finanzierungsvorschlaege/{finanzierungsvorschlagId}": { + "get": { + "tags": [ + "Finanzierungsvorschlag", + "Vorgänge" + ], + "summary": "Als Parameter wird die in BaufiSmart erzeugte Vorgangsnummer und die Id des Finanzierungsvorschlags erwartet. Achtung: Bei dem ausgegebenen Finanzierungsvorschlag handelt es sich um Mockdaten.", + "operationId": "getFinanzierungsvorschlag", + "produces": [ + "application/json;charset=UTF-8" + ], + "parameters": [ + { + "name": "vorgangsNummer", + "in": "path", + "description": "Die Nummer des Vorgangs zu dem die Finanzierungsvorschläge erzeugt wurden.", + "required": true, + "type": "string" + }, + { + "name": "finanzierungsvorschlagId", + "in": "path", + "description": "Die Id des Finanzierungsvorschlags.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Finanzierungsvorschlag" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "404": { + "description": "Not Found", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "405": { + "description": "Method Not Allowed", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "502": { + "description": "Bad Gateway", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "504": { + "description": "Gateway Timeout", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "security": [ + { + "oauth2": [ + "API" + ] + } + ] + } + }, "/v2/vorgaenge/{vorgangsNummer}/gemerkteAngebote": { "get": { "tags": [ @@ -1891,6 +2056,9 @@ "BeleihungsWert": { "type": "object", "properties": { + "adresse": { + "$ref": "#/definitions/Postadresse" + }, "beleihungsWert": { "type": "number" }, @@ -2871,6 +3039,74 @@ }, "title": "Error" }, + "EuropaceBausparAngebot": { + "type": "object", + "properties": { + "abschlussGebuehr": { + "type": "number" + }, + "angebotsHinweisFuerAntragsteller": { + "type": "string", + "description": "nur bei neuen extern berechneten Bausparverträgen und bei Gegenangeboten", + "allowEmptyValue": false + }, + "bausparSumme": { + "type": "number" + }, + "einmalzahlung": { + "type": "number" + }, + "gesamtLaufzeitInJahren": { + "type": "integer", + "format": "int32" + }, + "id": { + "type": "string" + }, + "produktAnbieter": { + "$ref": "#/definitions/ProduktAnbieter" + }, + "sonderZahlungen": { + "type": "array", + "items": { + "$ref": "#/definitions/SonderZahlung" + } + }, + "sparBeginn": { + "type": "string", + "format": "date", + "description": "Der berechnete Beginn des Besparens des Bausparvertrags.", + "allowEmptyValue": false + }, + "sparPhase": { + "$ref": "#/definitions/SparPhase" + }, + "tarif": { + "type": "string" + }, + "tilgungsPhase": { + "$ref": "#/definitions/TilgungsPhase" + }, + "typ": { + "type": "string" + }, + "vertragsBeginn": { + "type": "string", + "format": "date" + }, + "vertragsNummer": { + "type": "string" + }, + "verwaltungsgebuehrenJaehrlich": { + "type": "number" + }, + "zuteilungsDatum": { + "type": "string", + "format": "date" + } + }, + "title": "EuropaceBausparAngebot" + }, "Finanzbedarf": { "type": "object", "properties": { @@ -3064,6 +3300,112 @@ }, "title": "FinanzierungsObjekt" }, + "FinanzierungsvorschlaegeResource": { + "type": "object", + "properties": { + "finanzierungsvorschlaege": { + "type": "array", + "items": { + "$ref": "#/definitions/Finanzierungsvorschlag" + } + }, + "_links": { + "allowEmptyValue": false, + "$ref": "#/definitions/Links" + } + }, + "title": "FinanzierungsvorschlaegeResource" + }, + "Finanzierungsvorschlag": { + "type": "object", + "properties": { + "annahmeFrist": { + "type": "string", + "format": "date-time", + "description": "Die Annahmefrist des Angebots.", + "allowEmptyValue": false + }, + "bausparvertraege": { + "type": "array", + "description": "Liste von allen Bausparverträgen, die Bestandteil dieses Finanzierungsvorschlags sind.", + "allowEmptyValue": false, + "items": { + "$ref": "#/definitions/EuropaceBausparAngebot" + } + }, + "beleihung": { + "example": "Die Beleihungsrechnung aller Immobilien, die Bestandteil dieses Finanzierungsvorschlags sind.", + "allowEmptyValue": false, + "$ref": "#/definitions/BeleihungsRechnung" + }, + "darlehen": { + "type": "array", + "description": "Liste von allen Darlehen, die Bestandteil dieses Finanzierungsvorschlags sind.", + "allowEmptyValue": false, + "items": { + "$ref": "#/definitions/Darlehen" + } + }, + "darlehensSumme": { + "type": "number", + "example": 123.34, + "description": "Die gesamte Darlehenssumme in Euro für alle im Finanzierungsvorschlag enthaltenen Darlehen.", + "allowEmptyValue": false + }, + "effektivZins": { + "type": "number", + "example": 2.04, + "description": "Aus allen Darlehens Effektivzinssätzen wird ein aggregierter Mischzins in Prozent ausgegeben.", + "allowEmptyValue": false + }, + "erzeugtAm": { + "type": "string", + "format": "date-time", + "example": "2021-03-29T15:32:21.698Z", + "description": "Datum, an welchem der Finanzierungsvorschlag erzeugt wurde.", + "allowEmptyValue": false + }, + "id": { + "type": "string", + "description": "Id des Finanzierungsvorschlags", + "allowEmptyValue": false + }, + "machbarkeitsStatus": { + "type": "string", + "example": "MACHBAR", + "allowEmptyValue": false, + "enum": [ + "MACHBAR", + "UNTER_VORBEHALT_PRODUZENT", + "NICHT_MACHBAR" + ] + }, + "rateMonatlich": { + "type": "number", + "example": 123.34, + "description": "Die gesamte monatliche Rate in Euro.", + "allowEmptyValue": false + }, + "sollZins": { + "type": "number", + "example": 2.05, + "description": "Aus allen Darlehens Sollzinssätzen wird ein aggregierter Sollzins in Prozent ausgegeben.", + "allowEmptyValue": false + }, + "zinsBindung": { + "type": "string", + "example": "5 - 10 Jahre", + "description": "Die Zinsbindung wird über alle Darlehen als Intervall in Jahren angegeben.", + "allowEmptyValue": false + }, + "_links": { + "allowEmptyValue": false, + "$ref": "#/definitions/Links" + } + }, + "title": "Finanzierungsvorschlag", + "description": "Ein in BaufiSmart ausgehändigter Finanzierungsvorschlag." + }, "Finanzierungswunsch": { "type": "object", "properties": { @@ -4342,6 +4684,9 @@ "ereignisse": { "$ref": "#/definitions/Link" }, + "finanzierungsvorschlaege": { + "$ref": "#/definitions/Link" + }, "gemerkteAngebote": { "$ref": "#/definitions/Link" }, diff --git a/swagger.yaml b/swagger.yaml index 59113e3..596fa08 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -3,7 +3,7 @@ swagger: "2.0" info: description: "Mit dieser API können die Vorgänge aus der Europace Plattform ausgelesen\ \ werden." - version: "2.14" + version: "2.15" title: "Vorgänge API" contact: name: "Europace AG" @@ -434,6 +434,120 @@ paths: security: - oauth2: - "API" + /v2/vorgaenge/{vorgangsNummer}/finanzierungsvorschlaege: + get: + tags: + - "Finanzierungsvorschlag" + - "Vorgänge" + summary: "Als Parameter wird die in BaufiSmart erzeugte Vorgangsnummer erwartet.\ + \ Bei Finanzierungsvorschlägen handelt es sich um ausgehändigte Finanzierungsvorschlä\ + ge in Baufsmart. Achtung: Bei den ausgegebenen Finanzierungsvorschlägen handelt\ + \ es sich um Mockdaten." + operationId: "getFinanzierungsvorschlaege" + produces: + - "application/json;charset=UTF-8" + parameters: + - name: "vorgangsNummer" + in: "path" + description: "Die Nummer des Vorgangs zu dem die Finanzierungsvorschläge erzeugt\ + \ wurden." + required: true + type: "string" + responses: + 200: + description: "OK" + schema: + $ref: "#/definitions/FinanzierungsvorschlaegeResource" + 401: + description: "Unauthorized" + schema: + $ref: "#/definitions/Error" + 403: + description: "Forbidden" + schema: + $ref: "#/definitions/Error" + 404: + description: "Not Found" + schema: + $ref: "#/definitions/Error" + 405: + description: "Method Not Allowed" + schema: + $ref: "#/definitions/Error" + 500: + description: "Internal Server Error" + schema: + $ref: "#/definitions/Error" + 502: + description: "Bad Gateway" + schema: + $ref: "#/definitions/Error" + 504: + description: "Gateway Timeout" + schema: + $ref: "#/definitions/Error" + security: + - oauth2: + - "API" + /v2/vorgaenge/{vorgangsNummer}/finanzierungsvorschlaege/{finanzierungsvorschlagId}: + get: + tags: + - "Finanzierungsvorschlag" + - "Vorgänge" + summary: "Als Parameter wird die in BaufiSmart erzeugte Vorgangsnummer und die\ + \ Id des Finanzierungsvorschlags erwartet. Achtung: Bei dem ausgegebenen Finanzierungsvorschlag\ + \ handelt es sich um Mockdaten." + operationId: "getFinanzierungsvorschlag" + produces: + - "application/json;charset=UTF-8" + parameters: + - name: "vorgangsNummer" + in: "path" + description: "Die Nummer des Vorgangs zu dem die Finanzierungsvorschläge erzeugt\ + \ wurden." + required: true + type: "string" + - name: "finanzierungsvorschlagId" + in: "path" + description: "Die Id des Finanzierungsvorschlags." + required: true + type: "string" + responses: + 200: + description: "OK" + schema: + $ref: "#/definitions/Finanzierungsvorschlag" + 401: + description: "Unauthorized" + schema: + $ref: "#/definitions/Error" + 403: + description: "Forbidden" + schema: + $ref: "#/definitions/Error" + 404: + description: "Not Found" + schema: + $ref: "#/definitions/Error" + 405: + description: "Method Not Allowed" + schema: + $ref: "#/definitions/Error" + 500: + description: "Internal Server Error" + schema: + $ref: "#/definitions/Error" + 502: + description: "Bad Gateway" + schema: + $ref: "#/definitions/Error" + 504: + description: "Gateway Timeout" + schema: + $ref: "#/definitions/Error" + security: + - oauth2: + - "API" /v2/vorgaenge/{vorgangsNummer}/gemerkteAngebote: get: tags: @@ -1280,6 +1394,8 @@ definitions: BeleihungsWert: type: "object" properties: + adresse: + $ref: "#/definitions/Postadresse" beleihungsWert: type: "number" immobilie: @@ -1980,6 +2096,52 @@ definitions: traceId: type: "string" title: "Error" + EuropaceBausparAngebot: + type: "object" + properties: + abschlussGebuehr: + type: "number" + angebotsHinweisFuerAntragsteller: + type: "string" + description: "nur bei neuen extern berechneten Bausparverträgen und bei Gegenangeboten" + bausparSumme: + type: "number" + einmalzahlung: + type: "number" + gesamtLaufzeitInJahren: + type: "integer" + format: "int32" + id: + type: "string" + produktAnbieter: + $ref: "#/definitions/ProduktAnbieter" + sonderZahlungen: + type: "array" + items: + $ref: "#/definitions/SonderZahlung" + sparBeginn: + type: "string" + format: "date" + description: "Der berechnete Beginn des Besparens des Bausparvertrags." + sparPhase: + $ref: "#/definitions/SparPhase" + tarif: + type: "string" + tilgungsPhase: + $ref: "#/definitions/TilgungsPhase" + typ: + type: "string" + vertragsBeginn: + type: "string" + format: "date" + vertragsNummer: + type: "string" + verwaltungsgebuehrenJaehrlich: + type: "number" + zuteilungsDatum: + type: "string" + format: "date" + title: "EuropaceBausparAngebot" Finanzbedarf: type: "object" properties: @@ -2115,6 +2277,80 @@ definitions: - "MITTEL" - "EINFACH" title: "FinanzierungsObjekt" + FinanzierungsvorschlaegeResource: + type: "object" + properties: + finanzierungsvorschlaege: + type: "array" + items: + $ref: "#/definitions/Finanzierungsvorschlag" + _links: + $ref: "#/definitions/Links" + title: "FinanzierungsvorschlaegeResource" + Finanzierungsvorschlag: + type: "object" + properties: + annahmeFrist: + type: "string" + format: "date-time" + description: "Die Annahmefrist des Angebots." + bausparvertraege: + type: "array" + description: "Liste von allen Bausparverträgen, die Bestandteil dieses Finanzierungsvorschlags\ + \ sind." + items: + $ref: "#/definitions/EuropaceBausparAngebot" + beleihung: + $ref: "#/definitions/BeleihungsRechnung" + darlehen: + type: "array" + description: "Liste von allen Darlehen, die Bestandteil dieses Finanzierungsvorschlags\ + \ sind." + items: + $ref: "#/definitions/Darlehen" + darlehensSumme: + type: "number" + example: 123.34 + description: "Die gesamte Darlehenssumme in Euro für alle im Finanzierungsvorschlag\ + \ enthaltenen Darlehen." + effektivZins: + type: "number" + example: 2.04 + description: "Aus allen Darlehens Effektivzinssätzen wird ein aggregierter\ + \ Mischzins in Prozent ausgegeben." + erzeugtAm: + type: "string" + format: "date-time" + example: "2021-03-29T15:32:21.698Z" + description: "Datum, an welchem der Finanzierungsvorschlag erzeugt wurde." + id: + type: "string" + description: "Id des Finanzierungsvorschlags" + machbarkeitsStatus: + type: "string" + example: "MACHBAR" + enum: + - "MACHBAR" + - "UNTER_VORBEHALT_PRODUZENT" + - "NICHT_MACHBAR" + rateMonatlich: + type: "number" + example: 123.34 + description: "Die gesamte monatliche Rate in Euro." + sollZins: + type: "number" + example: 2.05 + description: "Aus allen Darlehens Sollzinssätzen wird ein aggregierter Sollzins\ + \ in Prozent ausgegeben." + zinsBindung: + type: "string" + example: "5 - 10 Jahre" + description: "Die Zinsbindung wird über alle Darlehen als Intervall in Jahren\ + \ angegeben." + _links: + $ref: "#/definitions/Links" + title: "Finanzierungsvorschlag" + description: "Ein in BaufiSmart ausgehändigter Finanzierungsvorschlag." Finanzierungswunsch: type: "object" properties: @@ -3016,6 +3252,8 @@ definitions: $ref: "#/definitions/Link" ereignisse: $ref: "#/definitions/Link" + finanzierungsvorschlaege: + $ref: "#/definitions/Link" gemerkteAngebote: $ref: "#/definitions/Link" self:
    NameTyp
    -

    vermietungsInformationen
    - optional

    -
    -
    -
    +
    +
    +

    vermietungsInformationen
    + optional

    +
    +
    +
    @@ -8516,16 +9981,20 @@

    GrundbuchAngabe

    NameBeschreibungTyp
    -

    anmerkungen
    -optional

    -
    BeschreibungTyp
    +
    +
    +

    anmerkungen
    + optional

    +
    +
    +

    string

    @@ -10927,12 +12396,14 @@

    SelfRelAndEreignisse

    -

    antraege
    - optional

    -
    -
    -
    +
    +
    +

    antraege
    + optional

    +
    +
    +
    @@ -10958,6 +12429,23 @@

    SelfRelAndEreignisse

    +
    +
    +

    finanzierungsvorschlaege
    + optional

    +
    +
    +
    +
    +
    +

    Link

    +
    +
    +
    @@ -10981,7 +12469,9 @@

    SelfRelAndEreignisse

    self
    optional

    -