Übersicht

SingleSignOn

Produktauswahlprozess

Abruf von Kriterien

Abruf der Gesamtbewertung

Beste Produkt am Markt

Indikation Produktqualität

Profilermittlung

productsmodular/getratingrange

Liefert das höchste und niedrigste Rating der Gesellschaft und optional ein bestimmtes Jahr.

Request

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

Schema: GET https://v7.fb-vertragscheck.fb-preview.de/external/productsmodular/getratingrange/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 ]
string
Jahr des Produktstandes; "current_products" für aktuelle Tarifgeneration, konkrete Jahreszahl oder auslassen für alle Tarife. Wird ignoriert, wenn year_from und year_to angegeben sind.
[ year_from ]
int
Untere Grenze für die Filterung auf die Gültigkeit der Produkte anstatt des Produktstandes. Ist derzeit, aufgrund der Datenlage, unscharf.
[ year_to ]
int
Obere Grenze für die Filterung auf die Gültigkeit der Produkte anstatt des Produktstandes. Ist derzeit, aufgrund der Datenlage, unscharf.
[ profile ] * required
string
Bewertungsprofil
[ add_compliance ]
bool
Get x/y compliance in addition to the percentage.
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "producttype": "TYPE_BU",
    "company_id": 1111,
    "year": "",
    "year_from": 2012,
    "year_to": 2012,
    "profile": "11",
    "add_compliance": false
}
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "producttype": "TYPE_BU",
    "company_id": 1111,
    "profile": "11"
}

Response

Schema: GET https://v7.fb-vertragscheck.fb-preview.de/external/productsmodular/getratingrange/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
Bewertungsintervall
property description options
ratingrange[ min_percentage ]
string
Mindestbewertung
ratingrange[ max_percentage ]
string
Maximalbewertung
ratingrange[ compliance_all ]
string
Alle Kriterien
ratingrange[ max_compliant ]
string
Max Kriterien erfüllt
ratingrange[ min_compliant ]
string
Min Kriterien erfüllt
example:

mime-type: application/json, text/json

{
    "status": "OK",
    "errors": [
        "Bitte geben Sie eine gültige Telefonnummer ein."
    ],
    "ratingrange": [
        {
            "min_percentage": "46",
            "max_percentage": "65",
            "compliance_all": "30",
            "max_compliant": "28",
            "min_compliant": "20"
        }
    ]
}