Übersicht

SingleSignOn

Produktauswahlprozess

Abruf von Kriterien

Abruf der Gesamtbewertung

Beste Produkt am Markt

Indikation Produktqualität

Profilermittlung

productsmodular/getproductconfiguration

Liefert die Produktkonfiguration zu den angegebenen Daten zurück. Diese ergibt sich aus dem gewählten Hauptprodukt und den gewählten Optionen.

Request

Endpoint: GET https://v7.fb-vertragscheck.fb-preview.de/external/productsmodular/getproductconfiguration

Schema: GET https://v7.fb-vertragscheck.fb-preview.de/external/productsmodular/getproductconfiguration/request/schema


property default description options
[ token ] * required
string
Token zur Authentifizierung mit der Schnittstelle
[ producttype ] * required
string
Kurzform der Produktart (Über Schnittstelle "/getproducttypes" zu erhalten)
[ product_id_version ] * required
string
Produkt ID und Version des Hauptproduktes
[ options ]
string
Produkt ID und Version der Optionen zum Hauptprodukt
[ profile ] * required
string
id des gewünschten Bewertungsprofils
[ show_max_options ]
boolean
Ermittlung einer passenden Konfiguration zu dem Hauptprodukt mit maximaler Ausprägung. Wenn options angegeben werden wird dieser Parameter ignoriert.
[ reference_pkfg ]
string
Referenzprodukt, dessen Bewertungskriterien verwendet werden
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "producttype": "TYPE_BU",
    "product_id_version": "500_1",
    "options": "600_2",
    "profile": "11",
    "show_max_options": true,
    "reference_pkfg": "12345678"
}
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "producttype": "TYPE_BU",
    "product_id_version": "500_1",
    "profile": "11"
}

Response

Schema: GET https://v7.fb-vertragscheck.fb-preview.de/external/productsmodular/getproductconfiguration/response/schema


property description options
[ status ] * required
string
Status des Aufrufs
OK: Anfrage erfolgreich
ERROR: Anfrage verlief fehlerhaft
[ errors ]
array
Aufgetretene Fehler (Wird nur bei "status: ERROR" gefüllt!

object
property description options
productconfiguration[ gesellschaft ]
string
Name der Gesellschaft
productconfiguration[ is_aktuell ]
integer
Produkt ist aktuell
Value Label
0 nicht aktuell
1 aktuell
productconfiguration[ pkfg ]
integer
Produktkonfigurations-Id
productconfiguration[ jahr ]
integer
Jahr
productconfiguration[ name ]
string
Produktname
productconfiguration[ percentage ]
integer
Erfüllungsgrad der Kriterien in %
productconfiguration[ benefit_surplus ]
array
Leistungsmerkmale die gegen Mehrbeitrag abgeschlossen werden können.
productconfiguration[ products ]
array
Produktdaten
example:

mime-type: application/json, text/json

{
    "status": "OK",
    "errors": [
        "Bitte geben Sie eine gültige Telefonnummer ein."
    ],
    "productconfiguration": {
        "gesellschaft": "Pfefferminzia",
        "is_aktuell": 0,
        "pkfg": 100000,
        "jahr": 2010,
        "name": "Produktname",
        "percentage": 65,
        "benefit_surplus": [
            "fahrraddiebstahl"
        ],
        "products": [
            {
                "pkfg": 987654321,
                "name": "Tarifname (lang)",
                "tarifname": "Tarifname (kurz)",
                "produkt_id": 1234,
                "produkt_version": 4,
                "produkt_ebene": 1,
                "is_option": true,
                "info": "Beitragsbefreiung HV + BU-Rente"
            }
        ]
    }
}