Übersicht

SingleSignOn

Produktauswahlprozess

Abruf von Kriterien

Abruf der Gesamtbewertung

Beste Produkt am Markt

Indikation Produktqualität

Profilermittlung

productselector/getproducts

Liefert ID und Version der Hauptprodukte einer Gesellschaft anhand des ausgewählten Produkttyps und dem angegebenen Jahr (bzw. current_products).

Request

Endpoint: POST https://v7.fb-vertragscheck.fb-preview.de/external/productselector/getproducts

Schema: GET https://v7.fb-vertragscheck.fb-preview.de/external/productselector/getproducts/request/schema


property default description options
[ token ] * required
string
Token zur Authentifizierung mit der Schnittstelle
[ producttype ] * required
string
Kurzform des Produkttyps (ü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)
[ use_valid_range ]
bool
Verwendet year für die Filterung auf die Gültigkeit der Produkte anstatt des Produktstandes. Ist aufgrund der Datenlage unscharf.
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "producttype": "TYPE_BU",
    "company_id": 1111,
    "year": "2012",
    "use_valid_range": false
}
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "producttype": "TYPE_BU",
    "company_id": 1111,
    "year": "2012"
}

Response

Schema: GET https://v7.fb-vertragscheck.fb-preview.de/external/productselector/getproducts/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
Liste der Hauptprodukte mit zugehöriger ID und Version
property description options
products[ value ]
string
Produkt-ID und Version des Produkts
products[ label ]
string
Name des Produkts
example:

mime-type: application/json, text/json

{
    "status": "OK",
    "errors": [
        "Bitte geben Sie ein gültiges Profil ein."
    ],
    "products": [
        {
            "value": "12345_6",
            "label": "Basis"
        }
    ]
}