KITT-1555 #ProduktanbieterParameter (Partnerkennzeichen) added to API…

…, example added; ReadMe improved

README.md

@@ -40,8 +40,8 @@ Request und Response sind in der [Swagger Definition](https://github.com/europac
 In einem KreditSmart Vorgang werden die Angebote zunächst von Europace ermittelt. Dabei wird die allgemeine Machbarkeit vorgeprüft, gegebenenfalls Anpassungen am Wunsch vorgenommen, 2/3 - Konditionen
 ermittelt sowie die Vollständigkeit des Vorgangs sichergestellt.
 
-Wenn alle notwendigen Daten vorhanden sind und die Vorprüfung erfolgreich war, kann die Annahme über die KEX Market Engine API erfolgen. Dabei werden die vom Vermittler <b>erfassten (nicht
-angepassten)</b> Daten zum Finanzierungswunsch sowie die Antragstellerdaten an den Produktanbieter übermittelt.
+Wenn alle notwendigen Daten vorhanden sind und die Vorprüfung erfolgreich war, kann die Annahme über die KEX Market Engine API erfolgen. Dabei wird <b>der Kundenwunsch</b>, also die vom Vermittler 
+<b>erfassten (nicht angepassten)</b> Daten zum Finanzierungswunsch sowie die Antragstellerdaten an den Produktanbieter übermittelt.
 
 Der Produktanbieter führt dann seinerseits alle für die Annahme des Angebots notwendigen Schritte durch:
 
@@ -129,8 +129,6 @@ sollten in diesem Fall der ursprünglichen Anfrage entsprechen.
 
 Meldungen werden erzeugt, um den Vermittler Hinweise zur Durchführung und Machbarkeit des Antrags zu geben. Es werden folgende Kategorien unterschieden.
 
-###### <code>meldungskategorie</code>
-
 | Meldungskategorie  | Beschreibung | <code>machbarkeitsstatus</code>| <code>angepasst</code> |
 |--------|--------|--------|--------|
 | <code>MACHBARKEIT</code> | Der Antrag wird abgelehnt. | NICHT_MACHBAR| <i>kein Einfluß<i> |
@@ -140,8 +138,6 @@ Meldungen werden erzeugt, um den Vermittler Hinweise zur Durchführung und Machb
 
 ##### Status
 
-###### <code>machbarkeitsstatus</code>
-
 | Machbarkeitsstatus  | Beschreibung |
 |--------|--------|
 | MACHBAR | Dem Antrag kann entsprochen werden. |

beispiele/example-annahme-erfolgreich.md

@@ -239,7 +239,12 @@ Es handelt sich um ein Beispiel zum besseren Verständnis der API.
   "handelsbeziehung": {
     "produktanbieter": "BEISPIEL_BANK",
     "kreditprovisionswunsch": 0.0123,
-    "vertriebsgruppe": "Beispielgruppe"
+    "vertriebsgruppe": "Beispielgruppe",
+    "produktanbieterParameter": [
+      {
+        "vermittlerNummerBankXY": "Wert aus dem EP-Partnermanagement"
+      }
+    ]
   },
   "beratungsart": "AUSSER_GESCHAEFTSRAUM_VERTRAG"
 }

swagger.yml

@@ -1,6 +1,6 @@
 swagger: '2.0'
 info:
-  version: 2.3.1
+  version: 2.4.0
   title: KEX Market Engine API
 basePath: /v1
 schemes:
@@ -169,7 +169,6 @@ definitions:
       nachname:
         type: string
 
-
   handelsbeziehung:
     type: object
     properties:
@@ -179,11 +178,21 @@ definitions:
       kreditprovisionswunsch:
         $ref: '#/definitions/prozent'
       vertriebsgruppe:
-        description: Wird vom Produktanbieter definiert um im Europace-Partnermanagement an der Handelsbeziehung gepflegt.
+        description: Wird vom Produktanbieter definiert und im Europace-Partnermanagement an der Handelsbeziehung gepflegt.
         type: string
+      produktanbieterParameter:
+        description: Zusätzlicher Parameter des Produktanbieters. Wird im Europace-Partnermanagement unter Partnerkennzeichen gepflegt.
+        type: array
+        items:
+          $ref: '#/definitions/produktanbieterParameter'
     required:
       - produktanbieter
 
+  produktanbieterParameter:
+    type: object
+    additionalProperties:
+      type: object
+
   ###
   ### Antragsteller
   ###