Übersicht

SingleSignOn

Produktauswahlprozess

Abruf von Kriterien

Abruf der Gesamtbewertung

Beste Produkt am Markt

Indikation Produktqualität

Profilermittlung

productsmodular/getproductoptions

Liefert die möglichen Optionen zu einem Hauptprodukt. Hierbei ist zu beachten, dass es Pflichtoptionen gibt, die benötigt werden, um weitere Informationen abrufen zu können.

Request

Endpoint: POST https://v7.fb-vertragscheck.fb-preview.de/external/productsmodular/getproductoptions

Schema: GET https://v7.fb-vertragscheck.fb-preview.de/external/productsmodular/getproductoptions/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)
[ company_id ] * required
integer
ID einer Gesellschaft (Über Schnittstelle "/getcompanies" zu erhalten)
[ year ] * required
string
Jahr des Produktstandes (Über Schnittstelle "/getyears" zu erhalten)
[ product_id_version ] * required
string
Produkt ID und Version (Über Schnittstelle "/getproducts" zu erhalten)
[ options ]
array
Ausgewählte Bausteine schalten ggf. abhängige Bausteine frei. Wurden weitere Bausteine freigeschaltet, so muss die Schnittstelle erneut aufgerufen werden
[ profile ] * required
string
Ein Franke und Bornberg Bewertungsprofil. Nur im Profil angegebene Kriterien werden für das Rating berücksichtigt.
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "producttype": "TYPE_UV",
    "company_id": 2493,
    "year": "current_products",
    "product_id_version": "55155_1",
    "options": [
        "55925_1"
    ],
    "profile": "4248"
}
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "producttype": "TYPE_UV",
    "company_id": 2493,
    "year": "current_products",
    "product_id_version": "55155_1",
    "profile": "4248"
}

Response

Schema: GET https://v7.fb-vertragscheck.fb-preview.de/external/productsmodular/getproductoptions/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!)

array
Produktoptionen
property description options
productoptions[ produkt_id ]
integer
Interne ID des Produktes
productoptions[ produkt_version ]
integer
Version in der das Produkt vorliegt
productoptions[ produkt_id_version ]
string
Zusammengesetzte Bezeichnung aus ID und Version
productoptions[ name ]
string
Name des Produktes
productoptions[ is_option ]
boolean
Produkt ist eine Option zum Hauptprodukt
productoptions[ produkt_ebene ]
integer
Produktoption liegt auf dieser Ebene in der Hierarchie abhängiger Optionen
productoptions[ info ]
string
Information zur Produktoption
productoptions[ mandatory ]
boolean
Dies ist eine Pflichtoption
productoptions[ mandatory_produkt_id_version ]
string
Zusammengesetzte Bezeichnung aus ID und Version des Hauptproduktes
example:

mime-type: application/json, text/json

{
    "status": "OK",
    "errors": [
        "Bitte geben Sie eine gültige Telefonnummer ein."
    ],
    "productoptions": [
        {
            "produkt_id": 12345,
            "produkt_version": 123,
            "produkt_id_version": "12345_123",
            "name": "Assistance, Stand 07.2015",
            "is_option": true,
            "produkt_ebene": 123,
            "info": "Beitragsbefreiung HV + BU-Rente",
            "mandatory": true,
            "mandatory_produkt_id_version": "23456_234"
        }
    ]
}